revxrsal.commands.process

Interface ParameterValidator<A extends CommandActor,T>

Type Parameters:

T - The parameter handler

All Known Implementing Classes:

LengthChecker, RangeChecker

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ParameterValidator<A extends CommandActor,T>

A validator for a specific parameter type. These validators can do extra checks on parameters after they are resolved from ParameterTypes.

Validators work on subclasses as well. For example, we can write a validator to validate a custom @Range(min, max) annotation for numbers:

{@code
 public enum RangeValidator implements ParameterValidator {
     INSTANCE;

Method Summary

Modifier and Type	Method and Description
void	validate(A actor, T value, @NotNull ParameterNode<A,T> parameter, @NotNull Lamp<A> lamp) Validates the specified value that was passed to a parameter.

Method Detail

validate

void validate(@NotNull
              A actor,
              T value,
              @NotNull
              @NotNull ParameterNode<A,T> parameter,
              @NotNull
              @NotNull Lamp<A> lamp)

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.

Parameters:

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

parameter - The parameter that will take this value

actor - The command actor