Package studio.mevera.imperat.command.arguments.type

Class OptionalArgument<S extends CommandSource,T>

java.lang.Object

studio.mevera.imperat.util.TypeCapturer

studio.mevera.imperat.command.arguments.type.ArgumentType<S,Optional<T>>

studio.mevera.imperat.command.arguments.type.OptionalArgument<S,T>

All Implemented Interfaces:

Prioritizable

public final class OptionalArgument<S extends CommandSource,T>
extends ArgumentType<S,Optional<T>>

Field Summary

Fields inherited from class studio.mevera.imperat.command.arguments.type.ArgumentType

suggestions, type

Constructor Summary

Constructors

Constructor	Description
OptionalArgument(TypeWrap<Optional<T>> typeWrap, ArgumentType<S,T> typeResolver)

Method Summary

Modifier and Type	Method	Description
DefaultValueProvider	getDefaultValueProvider()	Returns the default value supplier for the given source and command parameter.
SuggestionProvider<S>	getSuggestionProvider()	Returns the suggestion resolver associated with this parameter type.
boolean	isGreedy(Argument<S> parameter)	Determines if this parameter type is greedy, meaning it consumes multiple arguments.
Optional<T>	parse(@NotNull CommandContext<S> context, @NotNull Argument<S> argument, @NotNull String input)	Parses the argument value from the given input string, using the provided execution context.
Optional<T>	parse(@NotNull ExecutionContext<S> context, @NotNull Cursor<S> cursor)	Parses the argument value from the current position of the cursor, using the provided execution context.

Methods inherited from class studio.mevera.imperat.command.arguments.type.ArgumentType

addStaticSuggestions, equalsExactly, getNumberOfParametersToConsume, getPriority, isRelatedToType, type, wrappedType

Methods inherited from class studio.mevera.imperat.util.TypeCapturer

extractType, extractType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OptionalArgument

public OptionalArgument(TypeWrap<Optional<T>> typeWrap,
 ArgumentType<S,T> typeResolver)

Method Details

getSuggestionProvider

public SuggestionProvider<S> getSuggestionProvider()

Description copied from class: ArgumentType

Returns the suggestion resolver associated with this parameter type.

Overrides:

getSuggestionProvider in class ArgumentType<S extends CommandSource,Optional<T>>

Returns:

the suggestion resolver for generating suggestions based on the parameter type.

getDefaultValueProvider

public DefaultValueProvider getDefaultValueProvider()

Description copied from class: ArgumentType

Returns the default value supplier for the given source and command parameter. By default, this returns an empty supplier, indicating no default value.

Overrides:

getDefaultValueProvider in class ArgumentType<S extends CommandSource,Optional<T>>

Returns:

an DefaultValueProvider providing the default value, or empty if none.

isGreedy

public boolean isGreedy(Argument<S> parameter)

Description copied from class: ArgumentType

Determines if this parameter type is greedy, meaning it consumes multiple arguments. By default, returns false.

Overrides:

isGreedy in class ArgumentType<S extends CommandSource,Optional<T>>

Parameters:

parameter - the command parameter.

Returns:

true if greedy, false otherwise.

parse

public Optional<T> parse(@NotNull
 @NotNull CommandContext<S> context,
 @NotNull
 @NotNull Argument<S> argument,
 @NotNull
 @NotNull String input)
                  throws CommandException,
ResponseException

Description copied from class: ArgumentType

Parses the argument value from the given input string, using the provided execution context. This method is responsible for converting the raw input into the appropriate type, handling any necessary validation or error handling during the parsing process.

Specified by:

parse in class ArgumentType<S extends CommandSource,Optional<T>>

Parameters:

context - the execution context.

argument - the argument with this type.

input - the raw input string to parse.

Returns:

the resolved value of type T.

Throws:

CommandException - if parsing fails.

ResponseException

parse

public Optional<T> parse(@NotNull
 @NotNull ExecutionContext<S> context,
 @NotNull
 @NotNull Cursor<S> cursor)
                  throws CommandException,
ResponseException

Description copied from class: ArgumentType

Parses the argument value from the current position of the cursor, using the provided execution context. This method fetches the input from the cursor and delegates to ArgumentType.parse(CommandContext, Argument, String). This is the main entry point for argument parsing during command execution.

Overrides:

parse in class ArgumentType<S extends CommandSource,Optional<T>>

Parameters:

context - the execution context.

cursor - the command input stream.

Returns:

the resolved value of type T.

Throws:

CommandException - if parsing fails.

ResponseException