org.yarnandtail.andhow.valid

Class StringValidator.Regex

java.lang.Object

org.yarnandtail.andhow.valid.StringValidator.Regex

All Implemented Interfaces:

Validator<String>

Enclosing class:

StringValidator

public static class StringValidator.Regex
extends Object
implements Validator<String>

Validate based on a regex string.

Constructor Summary

Constructors

Constructor and Description
Regex(String regex)

Method Summary

Modifier and Type	Method and Description
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(String value)

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

getInvalidMessage

Constructor Detail

Regex

public Regex(String regex)

Method Detail

isSpecificationValid

public boolean isSpecificationValid()

Description copied from interface: Validator

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.

Specified by:

isSpecificationValid in interface Validator<String>

Returns:

getInvalidSpecificationMessage

public String getInvalidSpecificationMessage()

Description copied from interface: Validator

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.

Specified by:

getInvalidSpecificationMessage in interface Validator<String>

Returns:

A message describing an assumed problem with the validation specification.

isValid

public boolean isValid(String value)

Specified by:

isValid in interface Validator<String>

getTheValueMustDescription

public String getTheValueMustDescription()

Description copied from interface: Validator

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.*'"

Specified by:

getTheValueMustDescription in interface Validator<String>

Returns: