org.yarnandtail.andhow.api

Interface Validator<T>

All Known Implementing Classes:

DblValidator, DblValidator.GreaterThan, DblValidator.GreaterThanOrEqualTo, DblValidator.LessThan, DblValidator.LessThanOrEqualTo, IntValidator, IntValidator.GreaterThan, IntValidator.GreaterThanOrEqualTo, IntValidator.LessThan, IntValidator.LessThanOrEqualTo, LngValidator, LngValidator.GreaterThan, LngValidator.GreaterThanOrEqualTo, LngValidator.LessThan, LngValidator.LessThanOrEqualTo, LocalDateTimeValidator, LocalDateTimeValidator.After, LocalDateTimeValidator.Before, LocalDateTimeValidator.SameTimeOrAfter, LocalDateTimeValidator.SameTimeOrBefore, StringValidator.EndsWith, StringValidator.Regex, StringValidator.StartsWith

public interface Validator<T>

Author:

eeverman

Method Summary

Modifier and Type	Method and Description
default String	getInvalidMessage(T value) If the value is not valid, this will create a user message explaining why the value is not valid.
String	getInvalidSpecificationMessage() If the specification itself is invalid (such as a bad regex string), this will build a message describing the problem to the user.
String	getTheValueMustDescription() Get a description of the validation rule.
boolean	isSpecificationValid() Returns true if the validation criteria itself is valid.
boolean	isValid(T value)

Method Detail

isValid

boolean isValid(T value)

getInvalidMessage

default String getInvalidMessage(T value)

If the value is not valid, this will create a user message explaining why the value is not valid. This message should only refer to the value and the criteria and assume that it is included in a larger message that identifies the property and other context. This method should be prepared to handle nulls. Ending punctuation should not be included. Example: The value '999999999' is larger than the max value of 9999 The default implementation in the Validator Interface provides a reasonable default if the conventions are followed correction in the getTheValueMustDescription method.

Parameters:

value -

Returns:

getInvalidSpecificationMessage

String getInvalidSpecificationMessage()

If the specification itself is invalid (such as a bad regex string), this will build a message describing the problem to the user. This method may return a message regardless of if the validation is invalid or not - use isSpecificationValid() to determine if the Validator is configured correctly or not.

Returns:

A message describing an assumed problem with the validation specification.

isSpecificationValid

boolean isSpecificationValid()

Returns true if the validation criteria itself is valid. For things like regex expressions, this would check to see if the regex expression is a valid expression.

Returns:

getTheValueMustDescription

String getTheValueMustDescription()

Get a description of the validation rule. Assume that the text returned is prefixed with 'The value must...' As an example for a regex rule with the pattern 'ABC.*', the return could be: "match the regex pattern 'ABC.*'"

Returns: