java.lang.Object
- org.spongepowered.api.command.parameter.managed.standard.VariableValueParameters

public final class VariableValueParameters
extends java.lang.Object

Builders and factory for parameters that require configuration.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`VariableValueParameters.DynamicChoicesBuilder<T>`	A builder that creates a `ValueParameter` that tries to match an argument against a dynamic set of choices and returns an appropriate object based on the supplied argument.
`static interface`	`VariableValueParameters.Factory`	A factory that creates `ValueParameter`s or their builders.
`static interface`	`VariableValueParameters.LiteralBuilder<T>`	A builder that creates `ValueParameter`s that requires a specific sequence of arguments.
`static interface`	`VariableValueParameters.NumberRangeBuilder<T extends java.lang.Number>`	A builder that creates a parameter that can parse a bounded `Number`.
`static interface`	`VariableValueParameters.RegistryEntryBuilder<T>`	A builder that creates a `ValueParameter` that attempts to get a specific `registry` entry by the supplied ID.
`static interface`	`VariableValueParameters.StaticChoicesBuilder<T>`	A builder that creates a `ValueParameter` that tries to match an argument against a fixed set of choices and returns an appropriate object based on the supplied argument.
`static interface`	`VariableValueParameters.TextBuilder`	A builder that creates a parameter that serializes strings into `Component`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static VariableValueParameters.NumberRangeBuilder<java.lang.Double>`	`doubleRange()`	Creates a `VariableValueParameters.NumberRangeBuilder` that creates a bounded double `ValueParameter`.
`static <T> VariableValueParameters.DynamicChoicesBuilder<T>`	`dynamicChoicesBuilder(java.lang.Class<T> returnType)`	Creates a builder that can build a `ValueParameter` that tries to match an argument against a dynamic list of choices.
`static <T extends java.lang.Enum<T>> ValueParameter<T>`	`enumChoices(java.lang.Class<T> enumClass)`	Creates a `ValueParameter` that tries to match an argument with a value from a specified enum case-insensitively.
`static VariableValueParameters.NumberRangeBuilder<java.lang.Float>`	`floatRange()`	Creates a `VariableValueParameters.NumberRangeBuilder` that creates a bounded float `ValueParameter`.
`static VariableValueParameters.NumberRangeBuilder<java.lang.Integer>`	`integerRange()`	Creates a `VariableValueParameters.NumberRangeBuilder` that creates a bounded integer `ValueParameter`.
`static <T> VariableValueParameters.LiteralBuilder<T>`	`literalBuilder(java.lang.Class<T> returnType)`	Creates a builder that builds a `ValueParameter` that tries to match an a series of arguments with a supplied literal.
`static VariableValueParameters.NumberRangeBuilder<java.lang.Long>`	`longRange()`	Creates a `VariableValueParameters.NumberRangeBuilder` that creates a bounded long `ValueParameter`.
`static <T> VariableValueParameters.RegistryEntryBuilder<T>`	`registryEntryBuilder(java.util.function.Function<CommandContext,@Nullable RegistryHolder> holderProvider, RegistryType<T> registryKey)`	Creates a builder that can build a `ValueParameter` that returns an appropriate `registry` entry from an argument.
`static <T> VariableValueParameters.RegistryEntryBuilder<T>`	`registryEntryBuilder(java.util.List<java.util.function.Function<CommandContext,@Nullable RegistryHolder>> holderProviders, RegistryType<T> registryKey)`	Creates a builder that can build a `ValueParameter` that returns an appropriate `registry` entry from an argument.
`static <T> VariableValueParameters.RegistryEntryBuilder<T>`	`registryEntryBuilder(DefaultedRegistryType<T> type)`	Creates a builder that can build a `ValueParameter` that returns an appropriate type from the provided `Registry` from an argument.
`static <T> VariableValueParameters.StaticChoicesBuilder<T>`	`staticChoicesBuilder(java.lang.Class<T> returnType)`	Creates a builder that can build a `ValueParameter` that tries to match an argument against a fixed list of choices.
`static VariableValueParameters.TextBuilder`	`textBuilder()`	Creates a builder that builds a `ValueParameter` that tries to construct a `Component` from an argument.
`static ValueParameter<java.lang.String>`	`validatedString(java.util.regex.Pattern pattern)`	Creates a `ValueParameter` that validates the input.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - registryEntryBuilder
```
public static <T> VariableValueParameters.RegistryEntryBuilder<T> registryEntryBuilder(java.util.function.Function<CommandContext,@Nullable RegistryHolder> holderProvider,
                                                                                       RegistryType<T> registryKey)
```
    Creates a builder that can build a ValueParameter that returns an appropriate registry entry from an argument.
    
    Type Parameters:
    
    T - The type in the Registry
    
    Parameters:
    
    holderProvider - The provider for a RegistryHolder to retrieve the selected Registry from
    
    registryKey - The RegistryKey that represents the target Registry to get objects from
    
    Returns:
    
    The builder
  - registryEntryBuilder
```
public static <T> VariableValueParameters.RegistryEntryBuilder<T> registryEntryBuilder(java.util.List<java.util.function.Function<CommandContext,@Nullable RegistryHolder>> holderProviders,
                                                                                       RegistryType<T> registryKey)
```
    Creates a builder that can build a ValueParameter that returns an appropriate registry entry from an argument.
    
    Type Parameters:
    
    T - The type in the Registry
    
    Parameters:
    
    holderProviders - The providers for RegistryHolders to retrieve the selected Registry from
    
    registryKey - The RegistryKey that represents the target Registry to get objects from
    
    Returns:
    
    The builder
  - registryEntryBuilder
```
public static <T> VariableValueParameters.RegistryEntryBuilder<T> registryEntryBuilder(DefaultedRegistryType<T> type)
```
    Creates a builder that can build a ValueParameter that returns an appropriate type from the provided Registry from an argument.
    
    Type Parameters:
    
    T - The type in the Registry
    
    Parameters:
    
    type - The DefaultedRegistryType to use to retrieve a Registry that contains the objects to retrieve
    
    Returns:
    
    The builder
  - staticChoicesBuilder
```
public static <T> VariableValueParameters.StaticChoicesBuilder<T> staticChoicesBuilder(java.lang.Class<T> returnType)
```
    Creates a builder that can build a ValueParameter 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 resulting ValueParameter will return.
    
    Returns:
    
    The builder
  - dynamicChoicesBuilder
```
public static <T> VariableValueParameters.DynamicChoicesBuilder<T> dynamicChoicesBuilder(java.lang.Class<T> returnType)
```
    Creates a builder that can build a ValueParameter 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 resulting ValueParameter will return.
    
    Returns:
    
    The builder
  - literalBuilder
```
public static <T> VariableValueParameters.LiteralBuilder<T> literalBuilder(java.lang.Class<T> returnType)
```
    Creates a builder that builds a ValueParameter 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 resulting ValueParameter will return.
    
    Returns:
    
    The builder
  - textBuilder
```
public static VariableValueParameters.TextBuilder textBuilder()
```
    Creates a builder that builds a ValueParameter that tries to construct a Component from an argument.
    
    Returns:
    
    The new builder
  - enumChoices
```
public static <T extends java.lang.Enum<T>> ValueParameter<T> enumChoices(java.lang.Class<T> enumClass)
```
    Creates a ValueParameter that tries to match an argument with a value from a specified enum case-insensitively.
    
    Type Parameters:
    
    T - The Enum class type
    
    Parameters:
    
    enumClass - The Enum class type that this will represent
    
    Returns:
    
    The appropriate ValueParameter
  - doubleRange
```
public static VariableValueParameters.NumberRangeBuilder<java.lang.Double> doubleRange()
```
    Creates a VariableValueParameters.NumberRangeBuilder that creates a bounded double ValueParameter.
    
    Returns:
    
    The VariableValueParameters.NumberRangeBuilder
  - floatRange
```
public static VariableValueParameters.NumberRangeBuilder<java.lang.Float> floatRange()
```
    Creates a VariableValueParameters.NumberRangeBuilder that creates a bounded float ValueParameter.
    
    Returns:
    
    The VariableValueParameters.NumberRangeBuilder
  - integerRange
```
public static VariableValueParameters.NumberRangeBuilder<java.lang.Integer> integerRange()
```
    Creates a VariableValueParameters.NumberRangeBuilder that creates a bounded integer ValueParameter.
    
    Returns:
    
    The VariableValueParameters.NumberRangeBuilder
  - longRange
```
public static VariableValueParameters.NumberRangeBuilder<java.lang.Long> longRange()
```
    Creates a VariableValueParameters.NumberRangeBuilder that creates a bounded long ValueParameter.
    
    Returns:
    
    The VariableValueParameters.NumberRangeBuilder
  - validatedString
```
public static ValueParameter<java.lang.String> validatedString(java.util.regex.Pattern pattern)
```
    Creates a ValueParameter that validates the input.
    
    Parameters:
    
    pattern - The Pattern used to validate the string
    
    Returns:
    
    The ValueParameter

Class VariableValueParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

registryEntryBuilder

registryEntryBuilder

registryEntryBuilder

staticChoicesBuilder

dynamicChoicesBuilder

literalBuilder

textBuilder

enumChoices

doubleRange

floatRange

integerRange

longRange

validatedString