Package com.ultikits.ultitools.abstracts.command.validation

Class ValidatorChain

java.lang.Object

com.ultikits.ultitools.abstracts.command.validation.ValidatorChain

public final class ValidatorChain
extends Object

Manages a chain of validators that are executed in order. Thread-safe implementation supporting dynamic validator registration.

Since:

6.2.0

Version:

2.0.0

Author:

wisdomme

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ValidatorChain.Builder	Builder for creating validator chains.
static final class	ValidatorChain.ChainValidationResult	Result of chain validation.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	sorted
private final List<CommandValidator>	validators

Constructor Summary

Constructors

Constructor	Description
ValidatorChain()	Creates an empty validator chain.
ValidatorChain(Collection<CommandValidator> validators)	Creates a validator chain with the specified validators.

Method Summary

Modifier and Type	Method	Description
ValidatorChain	addValidator(CommandValidator validator)	Adds a validator to the chain.
static ValidatorChain.Builder	builder()	Creates a new builder for validator chains.
ValidatorChain	clear()	Clears all validators from the chain.
private void	ensureSorted()
List<CommandValidator>	getValidators()	Gets an unmodifiable view of the validators.
static boolean	isApplicable(CommandValidator validator, CommandContext context)	The single applicability check every caller must use before asking a validator to CommandValidator.validate(com.ultikits.ultitools.abstracts.command.CommandContext).
boolean	isEmpty()	Checks if the chain is empty.
static void	notifyRefused(CommandContext context, List<CommandValidator> passedValidators)	Calls CommandValidator.onRefused(CommandContext) on each of passedValidators, in order, for a dispatch refused after they passed and before the mapped method ran (#568).
private static RuntimeException	notifyRefused(CommandContext context, List<CommandValidator> passedValidators, RuntimeException pending)	Runs every refusal hook; returns the first exception a hook threw, or attaches it to pending (an exception already on its way out) and returns null.
ValidatorChain	removeValidator(CommandValidator validator)	Removes a validator from the chain.
ValidatorChain	removeValidators(Class<? extends CommandValidator> validatorClass)	Removes all validators of the specified type.
int	size()	Gets the number of validators in the chain.
private void	sort()
ValidatorChain.ChainValidationResult	validate(CommandContext context)	Validates the context through all validators in the chain.
ValidatorChain.ChainValidationResult	validateAll(CommandContext context)	Validates the context through all validators, collecting all failures.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

validators

private final List<CommandValidator> validators

sorted

private volatile boolean sorted

Constructor Details

ValidatorChain

public ValidatorChain()

Creates an empty validator chain.

ValidatorChain

public ValidatorChain(Collection<CommandValidator> validators)

Creates a validator chain with the specified validators.

Parameters:

validators - the validators to add

Method Details

addValidator

public ValidatorChain addValidator(CommandValidator validator)

Adds a validator to the chain.

Parameters:

validator - the validator to add

Returns:

this chain for fluent chaining

removeValidator

public ValidatorChain removeValidator(CommandValidator validator)

Removes a validator from the chain.

Parameters:

validator - the validator to remove

Returns:

this chain for fluent chaining

removeValidators

public ValidatorChain removeValidators(Class<? extends CommandValidator> validatorClass)

Removes all validators of the specified type.

Parameters:

validatorClass - the validator class to remove

Returns:

this chain for fluent chaining

clear

public ValidatorChain clear()

Clears all validators from the chain.

Returns:

this chain for fluent chaining

isApplicable

@Internal
public static boolean isApplicable(CommandValidator validator,
 CommandContext context)

The single applicability check every caller must use before asking a validator to CommandValidator.validate(com.ultikits.ultitools.abstracts.command.CommandContext). validate(com.ultikits.ultitools.abstracts.command.CommandContext) and validateAll(com.ultikits.ultitools.abstracts.command.CommandContext) both call this (rather than validator.shouldValidate(context) directly) so there is exactly one place this decision lives; a caller OUTSIDE this class that needs the same decision -- BaseCommandExecutor's gated help path, which invokes select validators directly without running the full chain -- calls this too, instead of re-declaring the same one-line condition a second time (WR-02, #413). This method is framework-internal and is not a supported extension point for module authors.

Parameters:

validator - the validator to check

context - the command context

Returns:

true iff validator should be asked to validate this context

Since:

6.3.0

validate

public ValidatorChain.ChainValidationResult validate(CommandContext context)

Validates the context through all validators in the chain. Stops at the first failure.

A runtime exception thrown from a validator's CommandValidator.shouldValidate(com.ultikits.ultitools.abstracts.command.CommandContext) or CommandValidator.validate(com.ultikits.ultitools.abstracts.command.CommandContext) refuses the dispatch: every validator that already passed receives CommandValidator.onRefused(com.ultikits.ultitools.abstracts.command.CommandContext) once, in chain order, and then the original exception propagates unchanged, with any exception a refusal hook threw attached to it as suppressed. The throwing validator itself, and every validator after it, receives nothing (#568 for validate; case 49 for shouldValidate).

Parameters:

context - the command context to validate

Returns:

the result of the validation

notifyRefused

@Internal
public static void notifyRefused(CommandContext context,
 List<CommandValidator> passedValidators)

Calls CommandValidator.onRefused(CommandContext) on each of passedValidators, in order, for a dispatch refused after they passed and before the mapped method ran (#568). Every hook runs even when an earlier one throws, so one validator's failing hook cannot keep a later validator -- a UsageLockValidator -- from releasing what it holds; the first exception a hook threw is rethrown afterwards, with any later ones suppressed on it.

Parameters:

context - the command context

passedValidators - the validators that passed for this dispatch, in chain order; may be null

Since:

6.3.0

notifyRefused

private static RuntimeException notifyRefused(CommandContext context,
 List<CommandValidator> passedValidators,
 RuntimeException pending)

Runs every refusal hook; returns the first exception a hook threw, or attaches it to pending (an exception already on its way out) and returns null.

validateAll

public ValidatorChain.ChainValidationResult validateAll(CommandContext context)

Validates the context through all validators, collecting all failures. Does not stop at the first failure.

A returned result, valid or not, calls no refusal hook: the caller owns refusal for it. A runtime exception thrown from a validator's CommandValidator.shouldValidate(com.ultikits.ultitools.abstracts.command.CommandContext) or CommandValidator.validate(com.ultikits.ultitools.abstracts.command.CommandContext) is handled as in validate(com.ultikits.ultitools.abstracts.command.CommandContext): every validator that already passed receives CommandValidator.onRefused(com.ultikits.ultitools.abstracts.command.CommandContext) once, in chain order, and then the original exception propagates unchanged, with any exception a refusal hook threw attached to it as suppressed (case 49).

Parameters:

context - the command context to validate

Returns:

the result containing all validation results

size

public int size()

Gets the number of validators in the chain.

Returns:

the number of validators

isEmpty

public boolean isEmpty()

Checks if the chain is empty.

Returns:

true if empty

getValidators

public List<CommandValidator> getValidators()

Gets an unmodifiable view of the validators.

Returns:

unmodifiable list of validators

ensureSorted

private void ensureSorted()

sort

private void sort()

builder

public static ValidatorChain.Builder builder()

Creates a new builder for validator chains.

Returns:

a new builder