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

Class ValidatorChain.ChainValidationResult

java.lang.Object

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

Enclosing class:

ValidatorChain

public static final class ValidatorChain.ChainValidationResult
extends Object

Result of chain validation.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<CommandValidator>	allFailedValidators
private final List<CommandValidator.ValidationResult>	allResults
private final CommandValidator.ValidationResult	failedResult
private final CommandValidator	failedValidator
private final List<CommandValidator>	passedValidators
private final boolean	valid

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ChainValidationResult(boolean valid, CommandValidator failedValidator, List<CommandValidator> allFailedValidators, CommandValidator.ValidationResult failedResult, List<CommandValidator.ValidationResult> allResults, List<CommandValidator> passedValidators)

Method Summary

Modifier and Type	Method	Description
(package private) static ValidatorChain.ChainValidationResult	failure(CommandValidator failedValidator, CommandValidator.ValidationResult failedResult, List<CommandValidator.ValidationResult> allResults, List<CommandValidator> passedValidators)
List<CommandValidator>	getAllFailedValidators()	Gets all failed validators.
List<CommandValidator.ValidationResult>	getAllResults()	Gets all validation results.
String	getErrorMessage()	Gets the error message from the first failure.
CommandValidator.ValidationResult	getFailedResult()	Gets the first failed result.
CommandValidator	getFailedValidator()	Gets the first failed validator.
List<CommandValidator>	getPassedValidators()	Gets the ordered list of validators whose CommandValidator.validate(CommandContext) succeeded during this chain run.
boolean	isValid()	Checks if all validations passed.
(package private) static ValidatorChain.ChainValidationResult	multipleFailures(List<CommandValidator> failedValidators, List<CommandValidator.ValidationResult> allResults, List<CommandValidator> passedValidators)
(package private) static ValidatorChain.ChainValidationResult	success(List<CommandValidator.ValidationResult> allResults, List<CommandValidator> passedValidators)

Methods inherited from class java.lang.Object

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

Field Details

valid

private final boolean valid

failedValidator

private final CommandValidator failedValidator

allFailedValidators

private final List<CommandValidator> allFailedValidators

failedResult

private final CommandValidator.ValidationResult failedResult

allResults

private final List<CommandValidator.ValidationResult> allResults

passedValidators

private final List<CommandValidator> passedValidators

Constructor Details

ChainValidationResult

private ChainValidationResult(boolean valid,
 CommandValidator failedValidator,
 List<CommandValidator> allFailedValidators,
 CommandValidator.ValidationResult failedResult,
 List<CommandValidator.ValidationResult> allResults,
 List<CommandValidator> passedValidators)

Method Details

success

static ValidatorChain.ChainValidationResult success(List<CommandValidator.ValidationResult> allResults,
 List<CommandValidator> passedValidators)

failure

static ValidatorChain.ChainValidationResult failure(CommandValidator failedValidator,
 CommandValidator.ValidationResult failedResult,
 List<CommandValidator.ValidationResult> allResults,
 List<CommandValidator> passedValidators)

multipleFailures

static ValidatorChain.ChainValidationResult multipleFailures(List<CommandValidator> failedValidators,
 List<CommandValidator.ValidationResult> allResults,
 List<CommandValidator> passedValidators)

isValid

public boolean isValid()

Checks if all validations passed.

Returns:

true if valid

getFailedValidator

public CommandValidator getFailedValidator()

Gets the first failed validator.

Returns:

the failed validator, or null if valid

getAllFailedValidators

public List<CommandValidator> getAllFailedValidators()

Gets all failed validators.

Returns:

list of failed validators

getFailedResult

public CommandValidator.ValidationResult getFailedResult()

Gets the first failed result.

Returns:

the failed result, or null if valid

getAllResults

public List<CommandValidator.ValidationResult> getAllResults()

Gets all validation results.

Returns:

list of all results

getPassedValidators

public List<CommandValidator> getPassedValidators()

Gets the ordered list of validators whose CommandValidator.validate(CommandContext) succeeded during this chain run. This is the single source of truth executeCommand drives CommandValidator.onComplete(CommandContext, boolean) from -- a validator absent from this list receives no post-action call, whether because it was skipped, never reached, or failed.

Returns:

unmodifiable, ordered list of validators that passed during this chain run

Since:

6.3.0

getErrorMessage

public String getErrorMessage()

Gets the error message from the first failure.

Returns:

the error message, or null if valid