Module com.github.cowwoc.requirements10.java

Package com.github.cowwoc.requirements10.java.validator

Interface StringValidator

All Superinterfaces:

ObjectComponent<StringValidator,String>, ValidatorComponent<StringValidator,String>

public interface StringValidator
extends ValidatorComponent<StringValidator,String>, ObjectComponent<StringValidator,String>

Validates the state of a String.

Method Summary

Modifier and Type	Method	Description
StringValidator	contains(String expected)	Ensures that the value contains some substring.
StringValidator	doesNotContain(String unwanted)	Ensures that the value does not contain some substring.
StringValidator	doesNotContainWhitespace()	Ensures that the value does not contain whitespace characters.
StringValidator	doesNotEndWith(String suffix)	Ensures that the value does not end with some suffix.
StringValidator	doesNotStartWith(String prefix)	Ensures that the value does not start with some prefix.
StringValidator	endsWith(String suffix)	Ensures that the value ends with some suffix.
StringValidator	isBlank()	Ensures that the value is empty or contains only whitespace codepoints.
StringValidator	isEmpty()	Ensures that the value is empty.
StringValidator	isNotBlank()	Ensures that the value is not empty or contains non-whitespace codepoints.
StringValidator	isNotEmpty()	Ensures that the value is not empty.
StringValidator	isStripped()	Ensures that the value does not contain leading or trailing whitespace, where whitespace is defined by String.strip().
StringValidator	isTrimmed()	Ensures that the value does not contain leading or trailing whitespace, where whitespace is defined by String.trim().
PrimitiveUnsignedIntegerValidator	length()	Returns a validator for the length of the String.
StringValidator	matches(String regex)	Ensures that the value matches a regular expression.
StringValidator	matches(Pattern regex)	Ensures that the value matches a regular expression.
StringValidator	startsWith(String prefix)	Ensures that the value starts with some prefix.

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ObjectComponent

getValue, isEqualTo, isEqualTo, isInstanceOf, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotInstanceOf, isNotInstanceOf, isNotNull, isNull, isReferenceEqualTo, isReferenceNotEqualTo

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ValidatorComponent

and, elseGetFailures, elseThrow, getContext, getContextAsString, getName, getValueOrDefault, validationFailed, withContext

Method Details

startsWith

StringValidator startsWith(String prefix)

Ensures that the value starts with some prefix.

Parameters:

prefix - the value that the string must start with

Returns:

this

Throws:

NullPointerException - if the value or prefix are null

IllegalArgumentException - if the value does not start with prefix

doesNotStartWith

StringValidator doesNotStartWith(String prefix)

Ensures that the value does not start with some prefix.

Parameters:

prefix - the value that the string may not start with

Returns:

this

Throws:

NullPointerException - if the value or prefix are null

IllegalArgumentException - if the value starts with prefix

endsWith

StringValidator endsWith(String suffix)

Ensures that the value ends with some suffix.

Parameters:

suffix - the value that the string must end with

Returns:

this

Throws:

NullPointerException - if the value or suffix are null

IllegalArgumentException - if the value does not end with suffix

doesNotEndWith

StringValidator doesNotEndWith(String suffix)

Ensures that the value does not end with some suffix.

Parameters:

suffix - the value that the string may not end with

Returns:

this

Throws:

NullPointerException - if the value or suffix are null

IllegalArgumentException - if the value ends with suffix

contains

StringValidator contains(String expected)

Ensures that the value contains some substring.

Parameters:

expected - the string that the value must contain

Returns:

this

Throws:

NullPointerException - if the value or expected are null

IllegalArgumentException - if the value does not contain expected

doesNotContain

StringValidator doesNotContain(String unwanted)

Ensures that the value does not contain some substring.

Parameters:

unwanted - the string that the value may not contain

Returns:

this

Throws:

NullPointerException - if the value or unwanted are null

IllegalArgumentException - if the value contains unwanted

doesNotContainWhitespace

StringValidator doesNotContainWhitespace()

Ensures that the value does not contain whitespace characters.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value contains whitespace characters

matches

StringValidator matches(String regex)

Ensures that the value matches a regular expression.

Parameters:

regex - the regular expression

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value does not match regex

matches

StringValidator matches(Pattern regex)

Ensures that the value matches a regular expression.

Parameters:

regex - the regular expression

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value does not match regex

isEmpty

StringValidator isEmpty()

Ensures that the value is empty.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not empty

isNotEmpty

StringValidator isNotEmpty()

Ensures that the value is not empty.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is empty

isTrimmed

StringValidator isTrimmed()

Ensures that the value does not contain leading or trailing whitespace, where whitespace is defined by String.trim().

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value contains leading or trailing whitespace

See Also:

• String.trim()
• isEmpty()

isStripped

StringValidator isStripped()

Ensures that the value does not contain leading or trailing whitespace, where whitespace is defined by String.strip().

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value contains leading or trailing whitespace

See Also:

• isBlank()

isBlank

StringValidator isBlank()

Ensures that the value is empty or contains only whitespace codepoints.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not empty or contains non-whitespace codepoints

isNotBlank

StringValidator isNotBlank()

Ensures that the value is not empty or contains non-whitespace codepoints.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is empty or contains only whitespace codepoints

length

PrimitiveUnsignedIntegerValidator length()

Returns a validator for the length of the String.

Returns:

a validator for the length of the String

Throws:

NullPointerException - if the value is null