org.yarnandtail.andhow.valid

Class StringValidator.StartsWith

java.lang.Object

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

org.yarnandtail.andhow.valid.StringValidator.StartsWith

All Implemented Interfaces:

Validator<String>

Enclosing class:

StringValidator

public static class StringValidator.StartsWith
extends BaseValidator<String>

Validate that a string starts with a specific string.

Constructor Summary

Constructors

Constructor and Description
StartsWith(String prefix, boolean ignoreCase)

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	isValidWithoutNull(String value) Same as isValid, but no null checking is needed.

Methods inherited from class org.yarnandtail.andhow.valid.BaseValidator

getInvalidMessage, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

StartsWith

public StartsWith(String prefix,
                  boolean ignoreCase)

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.

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.

Returns:

A message describing an assumed problem with the validation specification.

isValidWithoutNull

public boolean isValidWithoutNull(String value)

Description copied from class: BaseValidator

Same as isValid, but no null checking is needed.

Specified by:

isValidWithoutNull in class BaseValidator<String>

Parameters:

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

Returns:

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

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

Returns: