Package studio.mevera.imperat.command.parameters.type

Class ParameterOptional<S extends Source,T>

java.lang.Object

studio.mevera.imperat.util.TypeCapturer

studio.mevera.imperat.command.parameters.type.BaseParameterType<S,Optional<T>>

studio.mevera.imperat.command.parameters.type.ParameterOptional<S,T>

All Implemented Interfaces:

ParameterType<S,Optional<T>>

public final class ParameterOptional<S extends Source,T>
extends BaseParameterType<S,Optional<T>>

Field Summary

Fields inherited from class studio.mevera.imperat.command.parameters.type.BaseParameterType

suggestions, type

Constructor Summary

Constructors

Constructor	Description
ParameterOptional(TypeWrap<Optional<T>> typeWrap, ParameterType<S,T> typeResolver)

Method Summary

Modifier and Type	Method	Description
SuggestionResolver<S>	getSuggestionResolver()	Returns the suggestion resolver associated with this parameter type.
boolean	isGreedy(CommandParameter<S> parameter)	Determines if this parameter type is greedy, meaning it consumes multiple arguments.
boolean	matchesInput(int rawPosition, Context<S> context, CommandParameter<S> parameter)	Determines whether the provided input matches the expected format or criteria for a given command parameter.
@NotNull Optional<T>	resolve(@NotNull ExecutionContext<S> context, @NotNull CommandInputStream<S> inputStream, @NotNull String input)	Resolves the parameter value from the given input string, using the provided execution context and input stream.
OptionalValueSupplier	supplyDefaultValue()	Returns the default value supplier for the given source and command parameter.

Methods inherited from class studio.mevera.imperat.command.parameters.type.BaseParameterType

type, withSuggestions

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

Methods inherited from interface studio.mevera.imperat.command.parameters.type.ParameterType

equalsExactly, getConsumedArguments, isRelatedToType, wrappedType

Constructor Details

ParameterOptional

public ParameterOptional(TypeWrap<Optional<T>> typeWrap,
 ParameterType<S,T> typeResolver)

Method Details

resolve

@NotNull
public @NotNull Optional<T> resolve(@NotNull
 @NotNull ExecutionContext<S> context,
 @NotNull
 @NotNull CommandInputStream<S> inputStream,
 @NotNull
 @NotNull String input)
                             throws ImperatException

Description copied from interface: ParameterType

Resolves the parameter value from the given input string, using the provided execution context and input stream.

Parameters:

context - the execution context.

inputStream - the command input stream.

input - the raw input string.

Returns:

the resolved value, or null if resolution fails.

Throws:

ImperatException - if resolution fails due to an error.

getSuggestionResolver

public SuggestionResolver<S> getSuggestionResolver()

Description copied from class: BaseParameterType

Returns the suggestion resolver associated with this parameter type.

Specified by:

getSuggestionResolver in interface ParameterType<S extends Source,T>

Overrides:

getSuggestionResolver in class BaseParameterType<S extends Source,Optional<T>>

Returns:

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

matchesInput

public boolean matchesInput(int rawPosition,
 Context<S> context,
 CommandParameter<S> parameter)

Description copied from class: BaseParameterType

Determines whether the provided input matches the expected format or criteria for a given command parameter. this is used during CommandTree.contextMatch(Context, ArgumentInput)

Specified by:

matchesInput in interface ParameterType<S extends Source,T>

Overrides:

matchesInput in class BaseParameterType<S extends Source,Optional<T>>

Parameters:

rawPosition - The raw position of the argument in the input.

context - The context to be matched, providing necessary information about the command execution environment.

parameter - The command parameter that provides context for the input handling.

Returns:

true if the input matches the expected criteria; false otherwise.

supplyDefaultValue

public OptionalValueSupplier supplyDefaultValue()

Description copied from interface: ParameterType

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

Returns:

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

isGreedy

public boolean isGreedy(CommandParameter<S> parameter)

Description copied from interface: ParameterType

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

Parameters:

parameter - the command parameter.

Returns:

true if greedy, false otherwise.