Class ShortArgument.ShortParser<C>
- All Implemented Interfaces:
ArgumentParser<C,
Short>
- Enclosing class:
- ShortArgument<C>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final short
Constant for the default/unset maximum value.static final short
Constant for the default/unset minimum value.Fields inherited from interface cloud.commandframework.arguments.parser.ArgumentParser
DEFAULT_ARGUMENT_COUNT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionshort
getMax()
Get the max valueshort
getMin()
Get the min valueboolean
hasMax()
Get whether this parser has a maximum set.boolean
hasMin()
Get whether this parser has a minimum set.boolean
Check whether this argument parser is context free.@NonNull ArgumentParseResult<Short>
parse
(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> inputQueue) Parse command input into a command result.suggestions
(@NonNull CommandContext<C> commandContext, @NonNull String input) Get a list of suggested arguments that would be correctly parsed by this parserMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface cloud.commandframework.arguments.parser.ArgumentParser
getRequestedArgumentCount, map
-
Field Details
-
DEFAULT_MINIMUM
@API(status=STABLE, since="1.5.0") public static final short DEFAULT_MINIMUMConstant for the default/unset minimum value.- Since:
- 1.5.0
- See Also:
-
DEFAULT_MAXIMUM
@API(status=STABLE, since="1.5.0") public static final short DEFAULT_MAXIMUMConstant for the default/unset maximum value.- Since:
- 1.5.0
- See Also:
-
-
Constructor Details
-
ShortParser
public ShortParser(short min, short max) Construct a new short parser- Parameters:
min
- Minimum valuemax
- Maximum value
-
-
Method Details
-
parse
public @NonNull ArgumentParseResult<Short> parse(@NonNull CommandContext<C> commandContext, @NonNull Queue<@NonNull String> inputQueue) Description copied from interface:ArgumentParser
Parse command input into a command result.This method may be called when a command chain is being parsed for execution (using
CommandManager.executeCommand(Object, String)
) or when a command is being parsed to provide context for suggestions (usingCommandManager.suggest(Object, String)
). It is possible to useCommandContext.isSuggestions()
} to see what the purpose of the parsing is. Particular care should be taken when parsing for suggestions, as the parsing method is then likely to be called once for every character written by the command sender.This method should never throw any exceptions under normal circumstances. Instead, if the parsing for some reason cannot be done successfully
ArgumentParseResult.failure(Throwable)
should be returned. This then wraps any exception that should be forwarded to the command sender.The parser is assumed to be completely stateless and should not store any information about the command sender or the command context. Instead, information should be stored in the
CommandContext
.- Specified by:
parse
in interfaceArgumentParser<C,
Short> - Parameters:
commandContext
- Command contextinputQueue
- The queue of arguments- Returns:
- Parsed command result
-
isContextFree
public boolean isContextFree()Description copied from interface:ArgumentParser
Check whether this argument parser is context free. A context free parser will not use the provided command context, and so supports impromptu parsing- Specified by:
isContextFree
in interfaceArgumentParser<C,
Short> - Returns:
true
if the parser is context free, elsefalse
-
suggestions
public @NonNull List<@NonNull String> suggestions(@NonNull CommandContext<C> commandContext, @NonNull String input) Description copied from interface:ArgumentParser
Get a list of suggested arguments that would be correctly parsed by this parserThis method is likely to be called for every character provided by the sender and so it may be necessary to cache results locally to prevent unnecessary computations
- Specified by:
suggestions
in interfaceArgumentParser<C,
Short> - Parameters:
commandContext
- Command contextinput
- Input string- Returns:
- List of suggestions
-
getMax
public short getMax()Get the max value- Returns:
- Max value
-
getMin
public short getMin()Get the min value- Returns:
- Min value
-
hasMax
@API(status=STABLE, since="1.5.0") public boolean hasMax()Get whether this parser has a maximum set. This will compare the parser's maximum toDEFAULT_MAXIMUM
.- Returns:
- whether the parser has a maximum set
- Since:
- 1.5.0
-
hasMin
@API(status=STABLE, since="1.5.0") public boolean hasMin()Get whether this parser has a minimum set. This will compare the parser's minimum toDEFAULT_MINIMUM
.- Returns:
- whether the parser has a maximum set
- Since:
- 1.5.0
-