org.yarnandtail.andhow.valid

Class BaseValidator<T>

java.lang.Object

org.yarnandtail.andhow.valid.BaseValidator<T>

All Implemented Interfaces:

Validator<T>

Direct Known Subclasses:

BigDecValidator, DblValidator, IntValidator, LngValidator, LocalDateTimeValidator, StringValidator.EndsWith, StringValidator.OneOf, StringValidator.OneOfIgnoringCase, StringValidator.Regex, StringValidator.StartsWith

public abstract class BaseValidator<T>
extends Object
implements Validator<T>

Constructor Summary

Constructors

Constructor and Description
BaseValidator()

Method Summary

Modifier and Type	Method and Description
String	getInvalidMessage(T value) A user message explaining why the value is not valid if it fails this validation rule.
boolean	isValid(T value) Determines if the non-null value is valid according to the rule this validator enforces.
abstract boolean	isValidWithoutNull(T value) Same as isValid, but no null checking is needed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yarnandtail.andhow.api.Validator

getInvalidSpecificationMessage, getTheValueMustDescription, isSpecificationValid

Constructor Detail

BaseValidator

public BaseValidator()

Method Detail

isValid

public boolean isValid(T value)
                throws IllegalArgumentException

Description copied from interface: Validator

Determines if the non-null value is valid according to the rule this validator enforces.

Implementations should check for null and throw an IllegalArgumentException, since some types of validation operations may fail to detect a null and simply return false. Loaders (which call Validators) is a probable user extension point, so consistent handling and rejection of null values is important for custom Loaders to detect logic issues.

Specified by:

isValid in interface Validator<T>

Parameters:

value - A non-null value of type 'T'.

Returns:

boolean to indicate if the value is valid for this rule.

Throws:

IllegalArgumentException - If the value is null.

isValidWithoutNull

public abstract boolean isValidWithoutNull(T value)

Same as isValid, but no null checking is needed.

Parameters:

value - The value, which is guaranteed to not be null.

Returns:

Is the value valid according to the rule this Validator enforces?

getInvalidMessage

public String getInvalidMessage(T value)

Description copied from interface: Validator

A user message explaining why the value is not valid if it fails this validation rule.

The message should only refer to the value and rule criteria, and assume it is presented in a context that has already indicated an error and the Property. No leading or trailing punctuation should not be included.

Example: The value '999999999' is larger than the max value of 9999

Specified by:

getInvalidMessage in interface Validator<T>

Parameters:

value - The value which failed validation. Not null.

Returns:

A message explaining how the value violates the validation rule.