revxrsal.commands.parameter

Enum RangeChecker

java.lang.Object

java.lang.Enum<RangeChecker>

revxrsal.commands.parameter.RangeChecker

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RangeChecker>, ParameterValidator<CommandActor,java.lang.Number>

@ApiStatus.Internal
public enum RangeChecker
extends java.lang.Enum<RangeChecker>
implements ParameterValidator<CommandActor,java.lang.Number>

A parameter validator that checks for the @Range annotation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	validate(@NotNull CommandActor actor, java.lang.Number value, @NotNull ParameterNode<CommandActor,java.lang.Number> parameter, @NotNull Lamp<CommandActor> lamp) Validates the specified value that was passed to a parameter.
static RangeChecker	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RangeChecker[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final RangeChecker INSTANCE

Method Detail

values

public static RangeChecker[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RangeChecker c : RangeChecker.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RangeChecker valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

validate

public void validate(@NotNull
                     @NotNull CommandActor actor,
                     java.lang.Number value,
                     @NotNull
                     @NotNull ParameterNode<CommandActor,java.lang.Number> parameter,
                     @NotNull
                     @NotNull Lamp<CommandActor> lamp)

Description copied from interface: ParameterValidator

Validates the specified value that was passed to a parameter.

Ideally, a validator will want to throw an exception when the parameter is not valid, and then further handled with CommandExceptionHandler.

Specified by:

validate in interface ParameterValidator<CommandActor,java.lang.Number>

Parameters:

actor - The command actor

value - The parameter value. May or may not be null, depending on the resolver.

parameter - The parameter that will take this value