Package dev.polv.taleapi.command.argument

Class DoubleArgumentType

java.lang.Object
dev.polv.taleapi.command.argument.DoubleArgumentType
All Implemented Interfaces:
ArgumentType<Double>
public class DoubleArgumentType extends Object implements ArgumentType<Double>
Argument type for double values with optional bounds.

Example Usage


 // Any double
 Command.argument("value", DoubleArgumentType.doubleArg())

 // Double >= 0.0
 Command.argument("amount", DoubleArgumentType.doubleArg(0.0))

 // Double between 0.0 and 1.0
 Command.argument("percent", DoubleArgumentType.doubleArg(0.0, 1.0))

  • Method Details

    • doubleArg

      public static DoubleArgumentType doubleArg()
      Creates a double argument type with no bounds.
      Returns:
      a new double argument type

    • doubleArg

      public static DoubleArgumentType doubleArg(double min)
      Creates a double argument type with a minimum bound.
      Parameters:
      min - the minimum value (inclusive)
      Returns:
      a new double argument type

    • doubleArg

      public static DoubleArgumentType doubleArg(double min, double max)
      Creates a double argument type with both bounds.
      Parameters:
      min - the minimum value (inclusive)
      max - the maximum value (inclusive)
      Returns:
      a new double argument type

    • getMinimum

      public double getMinimum()
      Returns the minimum value.
      Returns:
      the minimum bound

    • getMaximum

      public double getMaximum()
      Returns the maximum value.
      Returns:
      the maximum bound

    • parse

      public Double parse(StringReader reader) throws CommandException
      Description copied from interface: ArgumentType
      Parses the argument from the input string.
      Specified by:
      parse in interface ArgumentType<Double>
      Parameters:
      reader - the string reader positioned at the argument
      Returns:
      the parsed value
      Throws:
      CommandException - if the argument cannot be parsed

    • listSuggestions

      public CompletableFuture<Suggestions> listSuggestions(CommandContext context, SuggestionsBuilder builder)
      Description copied from interface: ArgumentType
      Provides suggestions for this argument.

      Default implementation returns no suggestions.

      Specified by:
      listSuggestions in interface ArgumentType<Double>
      Parameters:
      context - the current command context (may have partial arguments)
      builder - the suggestions builder
      Returns:
      a future that completes with suggestions

    • getResultType

      public Class<Double> getResultType()
      Description copied from interface: ArgumentType
      Returns the Java type this argument parses to.
      Specified by:
      getResultType in interface ArgumentType<Double>
      Returns:
      the result type class

    • getTypeName

      public String getTypeName()
      Description copied from interface: ArgumentType
      Returns a human-readable name for this argument type.

      Used in error messages and help text.

      Specified by:
      getTypeName in interface ArgumentType<Double>
      Returns:
      the type name (e.g., "integer", "string", "player")

    • getExamples

      public String[] getExamples()
      Description copied from interface: ArgumentType
      Returns example values for this argument type.

      Used for documentation and error messages.

      Specified by:
      getExamples in interface ArgumentType<Double>
      Returns:
      an array of example values