Package org.incendo.cloud.annotations.descriptor

Interface ArgumentDescriptor

All Superinterfaces:

Descriptor

All Known Implementing Classes:

ImmutableArgumentDescriptor

@Immutable
@API(status=STABLE)
public interface ArgumentDescriptor
extends Descriptor

Method Summary

Modifier and Type	Method	Description
static @NonNull ImmutableArgumentDescriptor.Builder	builder()	Creates a new builder.
@Nullable DefaultValue<?,?>	defaultValue()	Returns the default value.
@Nullable Description	description()	Returns the description of the argument.
@NonNull String	name()	Returns the argument name
@NonNull Parameter	parameter()	Returns the parameter.
@Nullable String	parserName()	Returns the name of the parser to use.
@Nullable String	suggestions()	Returns the name of the suggestion provider to use.

Method Details

builder

static @NonNull ImmutableArgumentDescriptor.Builder builder()

Creates a new builder.

Returns:

the created builder

parameter

@NonNull Parameter parameter()

Returns the parameter.

Returns:

the parameter

name

@NonNull String name()

Returns the argument name

Specified by:

name in interface Descriptor

Returns:

the argument name

parserName

@Nullable String parserName()

Returns the name of the parser to use. If null the default parser for the parameter type will be used.

Returns:

the parser name, or null

suggestions

@Nullable String suggestions()

Returns the name of the suggestion provider to use. If the string is null, the default provider for the argument parser will be used. Otherwise, the ParserRegistry instance in the CommandManager will be queried for a matching suggestion provider.

For this to work, the suggestion needs to be registered in the parser registry. To do this, use ParserRegistry.registerSuggestionProvider(String, SuggestionProvider). The registry instance can be retrieved using CommandManager.parserRegistry().

Returns:

the name of the suggestion provider, or null

defaultValue

@Nullable DefaultValue<?,?> defaultValue()

Returns the default value.

Returns:

the default value, or null

description

@Nullable Description description()

Returns the description of the argument.

Returns:

the argument description, or null