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

Class ParameterFlag<S extends Source>

java.lang.Object

studio.mevera.imperat.util.TypeCapturer

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

studio.mevera.imperat.command.parameters.type.ParameterFlag<S>

All Implemented Interfaces:

ParameterType<S,ExtractedInputFlag>

public class ParameterFlag<S extends Source>
extends BaseParameterType<S,ExtractedInputFlag>

Field Summary

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

suggestions, type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParameterFlag(FlagData<S> flagData)

Method Summary

Modifier and Type	Method	Description
int	getConsumedArguments()	Returns the number of arguments consumed by this parameter type.
SuggestionResolver<S>	getSuggestionResolver()	Returns the suggestion resolver associated with this parameter type.
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.
@Nullable ExtractedInputFlag	resolve(@NotNull ExecutionContext<S> context, @NotNull CommandInputStream<S> commandInputStream, @NotNull String rawFlag)	Resolves the parameter value from the given input string, using the provided execution context and input stream.
ExtractedInputFlag	resolveFreeFlag(ExecutionContext<S> context, @NotNull CommandInputStream<S> commandInputStream, FlagData<S> freeFlag)

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, isGreedy, isRelatedToType, supplyDefaultValue, wrappedType

Constructor Details

ParameterFlag

protected ParameterFlag(FlagData<S> flagData)

Method Details

resolveFreeFlag

public ExtractedInputFlag resolveFreeFlag(ExecutionContext<S> context,
 @NotNull
 @NotNull CommandInputStream<S> commandInputStream,
 FlagData<S> freeFlag)
                                   throws ImperatException

Throws:

ImperatException

resolve

@Nullable
public @Nullable ExtractedInputFlag resolve(@NotNull
 @NotNull ExecutionContext<S> context,
 @NotNull
 @NotNull CommandInputStream<S> commandInputStream,
 @NotNull
 @NotNull String rawFlag)
                                     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.

commandInputStream - the command input stream.

rawFlag - the raw input string.

Returns:

the resolved value, or null if resolution fails.

Throws:

ImperatException - if resolution fails due to an error.

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,ExtractedInputFlag>

Overrides:

matchesInput in class BaseParameterType<S extends Source,ExtractedInputFlag>

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.

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,ExtractedInputFlag>

Overrides:

getSuggestionResolver in class BaseParameterType<S extends Source,ExtractedInputFlag>

Returns:

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

getConsumedArguments

public int getConsumedArguments()

Description copied from interface: ParameterType

Returns the number of arguments consumed by this parameter type. By default, returns 1.

Returns:

the number of consumed arguments.