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

Class ParameterString<S extends Source>

java.lang.Object

studio.mevera.imperat.util.TypeCapturer

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

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

All Implemented Interfaces:

ParameterType<S,String>

public final class ParameterString<S extends Source>
extends BaseParameterType<S,String>

Field Summary

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

suggestions, type

Method Summary

Modifier and Type	Method	Description
boolean	isGreedy(CommandParameter<S> parameter)	Determines if this parameter type is greedy, meaning it consumes multiple arguments.
@NotNull String	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.

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

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

Method Details

resolve

@NotNull
public @NotNull String 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.

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.