Class VariableValueParameters
java.lang.Object
org.spongepowered.api.command.parameter.managed.standard.VariableValueParameters
Builders and factory for parameters that require configuration.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
A builder that creates aValueParameter
that tries to match an argument against a dynamic set of choices and returns an appropriate object based on the supplied argument.static interface
A factory that createsValueParameter
s or their builders.static interface
A builder that createsValueParameter
s that requires a specific sequence of arguments.static interface
A builder that creates a parameter that can parse a boundedNumber
.static interface
A builder that creates aValueParameter
that attempts to get a specificregistry
entry by the supplied ID.static interface
A builder that creates aValueParameter
that tries to match an argument against a fixed set of choices and returns an appropriate object based on the supplied argument.static interface
A builder that creates a parameter that serializes strings intoComponent
. -
Method Summary
Modifier and TypeMethodDescriptionCreates aVariableValueParameters.NumberRangeBuilder
that creates a bounded doubleValueParameter
.static <T> VariableValueParameters.DynamicChoicesBuilder
<T> dynamicChoicesBuilder
(Class<T> returnType) Creates a builder that can build aValueParameter
that tries to match an argument against a dynamic list of choices.static <T extends Enum<T>>
ValueParameter<T> enumChoices
(Class<T> enumClass) Creates aValueParameter
that tries to match an argument with a value from a specified enum case-insensitively.Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded floatValueParameter
.Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded integerValueParameter
.static <T> VariableValueParameters.LiteralBuilder
<T> literalBuilder
(Class<T> returnType) Creates a builder that builds aValueParameter
that tries to match an a series of arguments with a supplied literal.Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded longValueParameter
.static <T> VariableValueParameters.RegistryEntryBuilder
<T> registryEntryBuilder
(Function<CommandContext, @Nullable RegistryHolder> holderProvider, RegistryType<T> registryKey) Creates a builder that can build aValueParameter
that returns an appropriateregistry
entry from an argument.static <T> VariableValueParameters.RegistryEntryBuilder
<T> registryEntryBuilder
(List<Function<CommandContext, @Nullable RegistryHolder>> holderProviders, RegistryType<T> registryKey) Creates a builder that can build aValueParameter
that returns an appropriateregistry
entry from an argument.static <T> VariableValueParameters.RegistryEntryBuilder
<T> Creates a builder that can build aValueParameter
that returns an appropriate type from the providedRegistry
from an argument.static <T> VariableValueParameters.StaticChoicesBuilder
<T> staticChoicesBuilder
(Class<T> returnType) Creates a builder that can build aValueParameter
that tries to match an argument against a fixed list of choices.Creates a builder that builds aValueParameter
that tries to construct aComponent
from an argument.static ValueParameter
<String> validatedString
(Pattern pattern) Creates aValueParameter
that validates the input.
-
Method Details
-
registryEntryBuilder
public static <T> VariableValueParameters.RegistryEntryBuilder<T> registryEntryBuilder(Function<CommandContext, @Nullable RegistryHolder> holderProvider, RegistryType<T> registryKey) Creates a builder that can build aValueParameter
that returns an appropriateregistry
entry from an argument.- Type Parameters:
T
- The type in theRegistry
- Parameters:
holderProvider
- The provider for aRegistryHolder
to retrieve the selectedRegistry
fromregistryKey
- TheRegistryKey
that represents the targetRegistry
to get objects from- Returns:
- The builder
-
registryEntryBuilder
public static <T> VariableValueParameters.RegistryEntryBuilder<T> registryEntryBuilder(List<Function<CommandContext, @Nullable RegistryHolder>> holderProviders, RegistryType<T> registryKey) Creates a builder that can build aValueParameter
that returns an appropriateregistry
entry from an argument.- Type Parameters:
T
- The type in theRegistry
- Parameters:
holderProviders
- The providers forRegistryHolder
s to retrieve the selectedRegistry
fromregistryKey
- TheRegistryKey
that represents the targetRegistry
to get objects from- Returns:
- The builder
-
registryEntryBuilder
public static <T> VariableValueParameters.RegistryEntryBuilder<T> registryEntryBuilder(DefaultedRegistryType<T> type) Creates a builder that can build aValueParameter
that returns an appropriate type from the providedRegistry
from an argument.- Type Parameters:
T
- The type in theRegistry
- Parameters:
type
- TheDefaultedRegistryType
to use to retrieve aRegistry
that contains the objects to retrieve- Returns:
- The builder
-
staticChoicesBuilder
public static <T> VariableValueParameters.StaticChoicesBuilder<T> staticChoicesBuilder(Class<T> returnType) Creates a builder that can build aValueParameter
that tries to match an argument against a fixed list of choices.If the list of choices changes during the lifetime of the server, use
dynamicChoicesBuilder(Class)
instead.- Type Parameters:
T
- The type that will be returned- Parameters:
returnType
- The type of object that the resultingValueParameter
will return.- Returns:
- The builder
-
dynamicChoicesBuilder
public static <T> VariableValueParameters.DynamicChoicesBuilder<T> dynamicChoicesBuilder(Class<T> returnType) Creates a builder that can build aValueParameter
that tries to match an argument against a dynamic list of choices.If the list of choices does not change during the lifetime of the server, use
staticChoicesBuilder(Class)
instead.- Type Parameters:
T
- The type that will be returned- Parameters:
returnType
- The type of object that the resultingValueParameter
will return.- Returns:
- The builder
-
literalBuilder
Creates a builder that builds aValueParameter
that tries to match an a series of arguments with a supplied literal.- Type Parameters:
T
- The type that will be returned- Parameters:
returnType
- The type of object that the resultingValueParameter
will return.- Returns:
- The builder
-
textBuilder
Creates a builder that builds aValueParameter
that tries to construct aComponent
from an argument.- Returns:
- The new builder
-
enumChoices
Creates aValueParameter
that tries to match an argument with a value from a specified enum case-insensitively.- Type Parameters:
T
- TheEnum
class type- Parameters:
enumClass
- TheEnum
class type that this will represent- Returns:
- The appropriate
ValueParameter
-
doubleRange
Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded doubleValueParameter
.- Returns:
- The
VariableValueParameters.NumberRangeBuilder
-
floatRange
Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded floatValueParameter
.- Returns:
- The
VariableValueParameters.NumberRangeBuilder
-
integerRange
Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded integerValueParameter
.- Returns:
- The
VariableValueParameters.NumberRangeBuilder
-
longRange
Creates aVariableValueParameters.NumberRangeBuilder
that creates a bounded longValueParameter
.- Returns:
- The
VariableValueParameters.NumberRangeBuilder
-
validatedString
Creates aValueParameter
that validates the input.- Parameters:
pattern
- ThePattern
used to validate the string- Returns:
- The
ValueParameter
-