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

Class ParameterEnum<S extends Source>

java.lang.Object

studio.mevera.imperat.util.TypeCapturer

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

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

All Implemented Interfaces:

ParameterType<S,Enum<?>>

public final class ParameterEnum<S extends Source>
extends BaseParameterType<S,Enum<?>>

Field Summary

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

suggestions, type

Constructor Summary

Constructors

Constructor	Description
ParameterEnum(TypeWrap<Enum<?>> typeWrap)

Method Summary

Modifier and Type	Method	Description
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 Enum<?>	resolve(@NotNull ExecutionContext<S> context, @NotNull CommandInputStream<S> commandInputStream, @NotNull String input)	Resolves the parameter value from the given input string, using the provided execution context and input stream.

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

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

Constructor Details

ParameterEnum

public ParameterEnum(TypeWrap<Enum<?>> typeWrap)

Method Details

resolve

@NotNull
public @NotNull Enum<?> resolve(@NotNull
 @NotNull ExecutionContext<S> context,
 @NotNull
 @NotNull CommandInputStream<S> commandInputStream,
 @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.

commandInputStream - 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.

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,Enum<?>>

Overrides:

matchesInput in class BaseParameterType<S extends Source,Enum<?>>

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.