Package org.incendo.cloud.component

Class TypedCommandComponent<C,T>

java.lang.Object

org.incendo.cloud.component.CommandComponent<C>

org.incendo.cloud.component.TypedCommandComponent<C,T>

All Implemented Interfaces:

Comparable<CommandComponent<C>>, PreprocessorHolder<C>, Describable, CloudKeyHolder<T>

@API(status=STABLE)
public final class TypedCommandComponent<C,T>
extends CommandComponent<C>
implements CloudKeyHolder<T>

Nested Class Summary

Nested classes/interfaces inherited from class org.incendo.cloud.component.CommandComponent

CommandComponent.Builder<C,T>, CommandComponent.ComponentType

Method Summary

Modifier and Type	Method	Description
@Nullable DefaultValue<C,T>	defaultValue()	Returns the default value, if specified.
@NonNull CloudKey<T>	key()	Returns the key that identifies this object.
@NonNull ArgumentParser<C,T>	parser()	Returns the parser.
@NonNull TypeToken<T>	valueType()	Returns the type of the values produced by the CommandComponent.parser().

Methods inherited from class org.incendo.cloud.component.CommandComponent

addPreprocessor, aliases, alternativeAliases, builder, builder, builder, compareTo, description, equals, hasDefaultValue, hashCode, name, ofType, optional, preprocess, preprocessors, required, suggestionProvider, toString, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

valueType

public @NonNull TypeToken<T> valueType()

Description copied from class: CommandComponent

Returns the type of the values produced by the CommandComponent.parser().

Overrides:

valueType in class CommandComponent<C>

Returns:

the types of the values produced by the parser

parser

public @NonNull ArgumentParser<C,T> parser()

Description copied from class: CommandComponent

Returns the parser.

Overrides:

parser in class CommandComponent<C>

Returns:

the parser

defaultValue

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

Description copied from class: CommandComponent

Returns the default value, if specified.

This should always return null if CommandComponent.required() is true.

Overrides:

defaultValue in class CommandComponent<C>

Returns:

the default value if specified, else null

key

public @NonNull CloudKey<T> key()

Description copied from interface: CloudKeyHolder

Returns the key that identifies this object.

Specified by:

key in interface CloudKeyHolder<C>

Returns:

the identifying key.