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

Interface VariableValueParameters.Factory

Enclosing class:

VariableValueParameters

public static interface VariableValueParameters.Factory

A factory that creates ValueParameters or their builders.

Method Summary

Modifier and Type	Method	Description
VariableValueParameters.NumberRangeBuilder<java.lang.Double>	createDoubleNumberRangeBuilder()	Creates a VariableValueParameters.NumberRangeBuilder for double values.
<T> VariableValueParameters.DynamicChoicesBuilder<T>	createDynamicChoicesBuilder(java.lang.Class<T> returnType)	Creates the VariableValueParameters.DynamicChoicesBuilder that will create objects that parse objects and return results of type T.
<T extends java.lang.Enum<T>> ValueParameter<T>	createEnumParameter(java.lang.Class<T> enumClass)	Creates the ValueParameter for the specified Enum
VariableValueParameters.NumberRangeBuilder<java.lang.Float>	createFloatNumberRangeBuilder()	Creates a VariableValueParameters.NumberRangeBuilder for float values.
VariableValueParameters.NumberRangeBuilder<java.lang.Integer>	createIntegerNumberRangeBuilder()	Creates a VariableValueParameters.NumberRangeBuilder for integer values.
<T> VariableValueParameters.LiteralBuilder<T>	createLiteralBuilder(java.lang.Class<T> returnType)	Creates the VariableValueParameters.LiteralBuilder that will create objects that parse objects and return results of type T.
VariableValueParameters.NumberRangeBuilder<java.lang.Long>	createLongNumberRangeBuilder()	Creates a VariableValueParameters.NumberRangeBuilder for long values.
<T> VariableValueParameters.RegistryEntryBuilder<T>	createRegistryEntryBuilder(java.util.List<java.util.function.Function<CommandContext,@Nullable RegistryHolder>> holderProvider, RegistryType<T> registryKey)	Creates a VariableValueParameters.RegistryEntryBuilder that retrieves objects from the Registry represented by the given RegistryKey and the provided RegistryHolder, which may be determined by the current state of the CommandContext.
<T> VariableValueParameters.RegistryEntryBuilder<T>	createRegistryEntryBuilder(DefaultedRegistryType<T> type)	Creates a VariableValueParameters.RegistryEntryBuilder that retrieves objects from the provided DefaultedRegistryReference, which retrieves an object from the appropriate Registry.
<T> VariableValueParameters.RegistryEntryBuilder<T>	createRegistryEntryBuilder(RegistryType<T> registryKey)	Creates a VariableValueParameters.RegistryEntryBuilder that retrieves objects from the Registry represented by the given RegistryKey and the provided RegistryHolder, which may be determined by the current state of the CommandContext.
<T> VariableValueParameters.StaticChoicesBuilder<T>	createStaticChoicesBuilder(java.lang.Class<T> returnType)	Creates the VariableValueParameters.StaticChoicesBuilder that will create objects that parse objects and return results of type T.
ValueParameter<java.lang.String>	createValidatedStringParameter(java.util.regex.Pattern pattern)	Creates a ValueParameter that validates its input against a Pattern.

Method Detail

createEnumParameter

<T extends java.lang.Enum<T>> ValueParameter<T> createEnumParameter(java.lang.Class<T> enumClass)

Creates the ValueParameter for the specified Enum

Type Parameters:

T - The type of Enum

Parameters:

enumClass - The Enum type to base the choices on

Returns:

The ValueParameter

createStaticChoicesBuilder

<T> VariableValueParameters.StaticChoicesBuilder<T> createStaticChoicesBuilder(java.lang.Class<T> returnType)

Creates the VariableValueParameters.StaticChoicesBuilder that will create objects that parse objects and return results of type T.

Type Parameters:

T - The parser return type

Parameters:

returnType - The Class of T

Returns:

The builder

createDynamicChoicesBuilder

<T> VariableValueParameters.DynamicChoicesBuilder<T> createDynamicChoicesBuilder(java.lang.Class<T> returnType)

Creates the VariableValueParameters.DynamicChoicesBuilder that will create objects that parse objects and return results of type T.

Type Parameters:

T - The parser return type

Parameters:

returnType - The Class of T

Returns:

The builder

createRegistryEntryBuilder

<T> VariableValueParameters.RegistryEntryBuilder<T> createRegistryEntryBuilder(RegistryType<T> registryKey)

Creates a VariableValueParameters.RegistryEntryBuilder that retrieves objects from the Registry represented by the given RegistryKey and the provided RegistryHolder, which may be determined by the current state of the CommandContext.

This element can support multiple functions that return RegistryHolders, however order matters, the Registry from the first holder that is resolved will be used. Holders may be added via VariableValueParameters.RegistryEntryBuilder.addHolderFunction(Function).

Type Parameters:

T - The type that the target Registry holds

Parameters:

registryKey - The RegistryKey that represents the target Registry in the RegistryHolder provided via holderProvider.

Returns:

The VariableValueParameters.RegistryEntryBuilder

createRegistryEntryBuilder

<T> VariableValueParameters.RegistryEntryBuilder<T> createRegistryEntryBuilder(java.util.List<java.util.function.Function<CommandContext,@Nullable RegistryHolder>> holderProvider,
                                                                               RegistryType<T> registryKey)

Creates a VariableValueParameters.RegistryEntryBuilder that retrieves objects from the Registry represented by the given RegistryKey and the provided RegistryHolder, which may be determined by the current state of the CommandContext.

This element can support multiple functions that return RegistryHolders, however order matters, the Registry from the first holder that is resolved will be used. Beyond the holders provided in this function, additional functions that resolve holders can be added through VariableValueParameters.RegistryEntryBuilder.addHolderFunction(Function).

Game and Server scoped RegistryHolder providers are available via VariableValueParameters.RegistryEntryBuilder.GLOBAL_HOLDER_PROVIDER and VariableValueParameters.RegistryEntryBuilder.SERVER_HOLDER_PROVIDER. World scoped providers are available via VariableValueParameters.RegistryEntryBuilder.WORLD_FROM_CAUSE_HOLDER_PROVIDER and VariableValueParameters.RegistryEntryBuilder.WORLD_FROM_LOCATABLE_HOLDER_PROVIDER.

Type Parameters:

T - The type that the target Registry holds

Parameters:

holderProvider - A Function that provides a RegistryHolder based on the CommandContext up to this parameter.

registryKey - The RegistryKey that represents the target Registry in the RegistryHolder provided via holderProvider.

Returns:

The VariableValueParameters.RegistryEntryBuilder

createRegistryEntryBuilder

<T> VariableValueParameters.RegistryEntryBuilder<T> createRegistryEntryBuilder(DefaultedRegistryType<T> type)

Creates a VariableValueParameters.RegistryEntryBuilder that retrieves objects from the provided DefaultedRegistryReference, which retrieves an object from the appropriate Registry.

Type Parameters:

T - The type that the target Registry holds

Parameters:

type - The registry type

Returns:

The VariableValueParameters.RegistryEntryBuilder

createLiteralBuilder

<T> VariableValueParameters.LiteralBuilder<T> createLiteralBuilder(java.lang.Class<T> returnType)

Creates the VariableValueParameters.LiteralBuilder that will create objects that parse objects and return results of type T.

Type Parameters:

T - The parser return type

Parameters:

returnType - The Class of T

Returns:

The builder

createIntegerNumberRangeBuilder

VariableValueParameters.NumberRangeBuilder<java.lang.Integer> createIntegerNumberRangeBuilder()

Creates a VariableValueParameters.NumberRangeBuilder for integer values.

Returns:

The VariableValueParameters.NumberRangeBuilder

createFloatNumberRangeBuilder

VariableValueParameters.NumberRangeBuilder<java.lang.Float> createFloatNumberRangeBuilder()

Creates a VariableValueParameters.NumberRangeBuilder for float values.

Returns:

The VariableValueParameters.NumberRangeBuilder

createDoubleNumberRangeBuilder

VariableValueParameters.NumberRangeBuilder<java.lang.Double> createDoubleNumberRangeBuilder()

Creates a VariableValueParameters.NumberRangeBuilder for double values.

Returns:

The VariableValueParameters.NumberRangeBuilder

createLongNumberRangeBuilder

VariableValueParameters.NumberRangeBuilder<java.lang.Long> createLongNumberRangeBuilder()

Creates a VariableValueParameters.NumberRangeBuilder for long values.

Returns:

The VariableValueParameters.NumberRangeBuilder

createValidatedStringParameter

ValueParameter<java.lang.String> createValidatedStringParameter(java.util.regex.Pattern pattern)

Creates a ValueParameter that validates its input against a Pattern.

Parameters:

pattern - The Pattern

Returns:

The ValueParameter