Package org.spongepowered.api.command.parameter.managed

Interface ValueParameter<T>

Type Parameters:

T - The type of object that is returned from the ValueParser upon successful parsing.

All Superinterfaces:

DefaultedRegistryValue<ValueParameter<?>>, ValueCompleter, ValueParser<T>, ValueUsage

All Known Subinterfaces:

ResourceKeyedValueParameter<T>, ValueParameter.Simple<T>

public interface ValueParameter<T>
extends DefaultedRegistryValue<ValueParameter<?>>, ValueCompleter, ValueParser<T>, ValueUsage

Combines the ValueParser, ValueCompleter and ValueUsage into one object.

See Also:

• ValueCompleter
• ValueParser
• ValueUsage

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ValueParameter.Simple<T>	A ValueParameter that does not rely on the CommandContext or Parameter.Key to parse its results.

Method Summary

Modifier and Type	Method	Description
default ValueParameter<T>	bind(RegistryHolder registryHolder)	Creates a new ValueCompleter that is bound to a specific registry holder.
default String	usage(@NonNull String key)	Gets the usage string for the parameter.

Methods inherited from interface org.spongepowered.api.registry.DefaultedRegistryValue

asDefaultedReference, findKey, key

Methods inherited from interface org.spongepowered.api.command.parameter.managed.ValueCompleter

complete

Methods inherited from interface org.spongepowered.api.command.parameter.managed.ValueParser

clientCompletionType, parseValue

Method Details

usage

default String usage(@NonNull String key)

Description copied from interface: ValueUsage

Gets the usage string for the parameter.

Specified by:

usage in interface ValueUsage

Parameters:

key - The String that defines the parameter key

Returns:

The usage

bind

default ValueParameter<T> bind(RegistryHolder registryHolder)

Description copied from interface: ValueCompleter

Creates a new ValueCompleter that is bound to a specific registry holder.

Specified by:

bind in interface ValueCompleter

Specified by:

bind in interface ValueParser<T>

Parameters:

registryHolder - The owning registry holder.

Returns:

The bound ValueCompleter.