Package org.incendo.cloud.component

Class CommandComponent.Builder<C,T>

java.lang.Object

org.incendo.cloud.component.CommandComponent.Builder<C,T>

Enclosing class:

CommandComponent<C>

@API(status=STABLE)
public static class CommandComponent.Builder<C,T>
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
@NonNull TypedCommandComponent<C,T>	build()	Builds a command component using this builder.
@NonNull CommandComponent.Builder<C,T>	commandManager(@Nullable CommandManager<C> commandManager)	Sets the command manager, which will be used to create a parser if none is provided.
@Nullable DefaultValue<C,T>	defaultValue()	Returns the current default value, if it has been set.
@NonNull CommandComponent.Builder<C,T>	defaultValue(@Nullable DefaultValue<? super C,T> defaultValue)	Sets the defaultValue.
@MonotonicNonNull Description	description()	Returns the current description.
@NonNull CommandComponent.Builder<C,T>	description(@NonNull Description description)	Sets the description.
@NonNull CommandComponent.Builder<C,T>	key(@NonNull CloudKey<T> cloudKey)	Sets the name(String) and the value type to the values contained in the given cloudKey.
@MonotonicNonNull String	name()	Returns the current name, if it has been set.
@NonNull CommandComponent.Builder<C,T>	name(@NonNull String name)	Sets the name of the component.
@NonNull CommandComponent.Builder<C,T>	optional()	Sets required to false.
@NonNull CommandComponent.Builder<C,T>	optional(@Nullable DefaultValue<? super C,T> defaultValue)	Sets required to true and updates the defaultValue.
@MonotonicNonNull ParserDescriptor<C,T>	parser()	Returns the current parser, if it has been set.
@NonNull CommandComponent.Builder<C,T>	parser(@NonNull ArgumentParser<? super C,T> parser)	Sets the parser.
@NonNull CommandComponent.Builder<C,T>	parser(@NonNull ParserDescriptor<? super C,T> parserDescriptor)	Sets the parser and valueType.
@NonNull CommandComponent.Builder<C,T>	preprocessor(@NonNull ComponentPreprocessor<? super C> preprocessor)	Adds the preprocessor.
@NonNull CommandComponent.Builder<C,T>	preprocessors(@NonNull Collection<ComponentPreprocessor<C>> preprocessors)	Adds the preprocessors.
@NonNull CommandComponent.Builder<C,T>	required()	Sets required to true.
@NonNull CommandComponent.Builder<C,T>	required(boolean required)	Sets whether the component is required.
@MonotonicNonNull SuggestionProvider<C>	suggestionProvider()	Returns the current suggestion provider, if it has been set.
@NonNull CommandComponent.Builder<C,T>	suggestionProvider(@Nullable SuggestionProvider<? super C> suggestionProvider)	Sets the suggestionProvider.
@NonNull CommandComponent.Builder<C,T>	valueType(@NonNull TypeToken<T> valueType)	Sets the valueType.
@NonNull CommandComponent.Builder<C,T>	valueType(@NonNull Class<T> valueType)	Sets the valueType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder()

Method Details

commandManager

public @NonNull CommandComponent.Builder<C,T> commandManager(@Nullable CommandManager<C> commandManager)

Sets the command manager, which will be used to create a parser if none is provided.

If the command manager is null and no parser(ArgumentParser) is specified then the command component is invalid.

Parameters:

commandManager - the command manager

Returns:

this

key

public @NonNull CommandComponent.Builder<C,T> key(@NonNull CloudKey<T> cloudKey)

Sets the name(String) and the value type to the values contained in the given cloudKey.

Parameters:

cloudKey - the key

Returns:

this

name

public @MonotonicNonNull String name()

Returns the current name, if it has been set.

Returns:

current name

name

public @NonNull CommandComponent.Builder<C,T> name(@NonNull String name)

Sets the name of the component.

The name is used to extract the parsed values from the CommandContext.

Parameters:

name - the name

Returns:

this

valueType

public @NonNull CommandComponent.Builder<C,T> valueType(@NonNull TypeToken<T> valueType)

Sets the valueType.

This is always required and the component will be invalid is the value type is null when the component is built.

If no parser is specified then the default parser will be retrieved from the command manager.

Parameters:

valueType - the value type

Returns:

this

valueType

public @NonNull CommandComponent.Builder<C,T> valueType(@NonNull Class<T> valueType)

Sets the valueType.

This is always required and the component will be invalid is the value type is null when the component is built.

If no parser is specified then the default parser will be retrieved from the command manager.

Parameters:

valueType - the value type

Returns:

this

parser

public @MonotonicNonNull ParserDescriptor<C,T> parser()

Returns the current parser, if it has been set.

Returns:

current parser

parser

public @NonNull CommandComponent.Builder<C,T> parser(@NonNull ParserDescriptor<? super C,T> parserDescriptor)

Sets the parser and valueType.

Parameters:

parserDescriptor - descriptor of the parser

Returns:

this

defaultValue

public @Nullable DefaultValue<C,T> defaultValue()

Returns the current default value, if it has been set.

Returns:

current default value

defaultValue

public @NonNull CommandComponent.Builder<C,T> defaultValue(@Nullable DefaultValue<? super C,T> defaultValue)

Sets the defaultValue.

This should not be set if required is true.

Parameters:

defaultValue - the default value

Returns:

this

required

public @NonNull CommandComponent.Builder<C,T> required(boolean required)

Sets whether the component is required.

Defaults to true.

Parameters:

required - whether component is required

Returns:

this

required

public @NonNull CommandComponent.Builder<C,T> required()

Sets required to true.

Returns:

this

optional

public @NonNull CommandComponent.Builder<C,T> optional()

Sets required to false.

Returns:

this

optional

public @NonNull CommandComponent.Builder<C,T> optional(@Nullable DefaultValue<? super C,T> defaultValue)

Sets required to true and updates the defaultValue.

Parameters:

defaultValue - the default value

Returns:

this

description

public @MonotonicNonNull Description description()

Returns the current description.

Returns:

current description

description

public @NonNull CommandComponent.Builder<C,T> description(@NonNull Description description)

Sets the description.

Defaults to Description.empty().

Parameters:

description - the description

Returns:

this

suggestionProvider

public @MonotonicNonNull SuggestionProvider<C> suggestionProvider()

Returns the current suggestion provider, if it has been set.

Returns:

current suggestion provider

suggestionProvider

public @NonNull CommandComponent.Builder<C,T> suggestionProvider(@Nullable SuggestionProvider<? super C> suggestionProvider)

Sets the suggestionProvider.

Defaults to parser.

Parameters:

suggestionProvider - the suggestion provider

Returns:

this

preprocessor

public @NonNull CommandComponent.Builder<C,T> preprocessor(@NonNull ComponentPreprocessor<? super C> preprocessor)

Adds the preprocessor.

Parameters:

preprocessor - the preprocessor

Returns:

this

preprocessors

public @NonNull CommandComponent.Builder<C,T> preprocessors(@NonNull Collection<ComponentPreprocessor<C>> preprocessors)

Adds the preprocessors.

Parameters:

preprocessors - the preprocessors

Returns:

this

parser

public @NonNull CommandComponent.Builder<C,T> parser(@NonNull ArgumentParser<? super C,T> parser)

Sets the parser. If no parser is set and the manager has been set then the default parser for the valueType will be used instead.

If both parser and manager are null it will not be possible to parse the component.

Parameters:

parser - the parser

Returns:

this

build

public @NonNull TypedCommandComponent<C,T> build()

Builds a command component using this builder.

Each invocation produces a unique component.

Returns:

the built component