Module com.github.cowwoc.requirements10.java

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

Interface CharacterValidator

All Superinterfaces:

ComparableComponent<CharacterValidator,Character>, ObjectComponent<CharacterValidator,Character>, ValidatorComponent<CharacterValidator,Character>

public interface CharacterValidator
extends ValidatorComponent<CharacterValidator,Character>, ObjectComponent<CharacterValidator,Character>, ComparableComponent<CharacterValidator,Character>

Validates the state of a Character.

Method Summary

Modifier and Type	Method	Description
CharacterValidator	isBetween(char minimum, boolean minimumIsInclusive, char maximum, boolean maximumIsInclusive)	Ensures that the value is within a range.
CharacterValidator	isBetween(char minimumInclusive, char maximumExclusive)	Ensures that the value is within a range.
CharacterValidator	isGreaterThan(char minimumExclusive)	Ensures that the value is greater than a lower bound.
CharacterValidator	isGreaterThan(char minimumExclusive, String name)	Ensures that the value is greater than a lower bound.
CharacterValidator	isGreaterThanOrEqualTo(char minimumInclusive)	Ensures that the value is greater than or equal to a minimum value.
CharacterValidator	isGreaterThanOrEqualTo(char minimumInclusive, String name)	Ensures that the value is greater than or equal a minimum value.
CharacterValidator	isLessThan(char maximumExclusive)	Ensures that the value is less than an upper bound.
CharacterValidator	isLessThan(char maximumExclusive, String name)	Ensures that the value is less than an upper bound.
CharacterValidator	isLessThanOrEqualTo(char maximumInclusive)	Ensures that the value is less than or equal to a maximum value.
CharacterValidator	isLessThanOrEqualTo(char maximumInclusive, String name)	Ensures that the value is less than or equal to a maximum value.

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

isBetween, isBetween, isGreaterThan, isGreaterThan, isGreaterThanOrEqualTo, isGreaterThanOrEqualTo, isLessThan, isLessThan, isLessThanOrEqualTo, isLessThanOrEqualTo

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

isLessThan

CharacterValidator isLessThan(char maximumExclusive)

Ensures that the value is less than an upper bound.

Parameters:

maximumExclusive - the exclusive upper bound

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is greater than or equal to maximumExclusive

isLessThan

CharacterValidator isLessThan(char maximumExclusive,
 String name)

Ensures that the value is less than an upper bound.

Parameters:

maximumExclusive - the exclusive upper bound

name - the name of the upper bound

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the value is greater than or equal to maximumExclusive

isLessThanOrEqualTo

CharacterValidator isLessThanOrEqualTo(char maximumInclusive)

Ensures that the value is less than or equal to a maximum value.

Parameters:

maximumInclusive - the inclusive upper value

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is greater than maximumInclusive

isLessThanOrEqualTo

CharacterValidator isLessThanOrEqualTo(char maximumInclusive,
 String name)

Ensures that the value is less than or equal to a maximum value.

Parameters:

maximumInclusive - the maximum value

name - the name of the maximum value

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the value is greater than maximumInclusive

isGreaterThanOrEqualTo

CharacterValidator isGreaterThanOrEqualTo(char minimumInclusive)

Ensures that the value is greater than or equal to a minimum value.

Parameters:

minimumInclusive - the minimum value

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is less than minimumInclusive

isGreaterThanOrEqualTo

CharacterValidator isGreaterThanOrEqualTo(char minimumInclusive,
 String name)

Ensures that the value is greater than or equal a minimum value.

Parameters:

minimumInclusive - the minimum value

name - the name of the minimum value

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the value is less than minimumInclusive

isGreaterThan

CharacterValidator isGreaterThan(char minimumExclusive)

Ensures that the value is greater than a lower bound.

Parameters:

minimumExclusive - the exclusive lower bound

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is less than or equal to minimumExclusive

isGreaterThan

CharacterValidator isGreaterThan(char minimumExclusive,
 String name)

Ensures that the value is greater than a lower bound.

Parameters:

minimumExclusive - the exclusive lower bound

name - the name of the lower bound

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the value is less or equal to minimumExclusive

isBetween

CharacterValidator isBetween(char minimumInclusive,
 char maximumExclusive)

Ensures that the value is within a range.

Parameters:

minimumInclusive - the lower bound of the range (inclusive)

maximumExclusive - the upper bound of the range (exclusive)

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if:

• minimumInclusive is greater than maximumExclusive
• the value is greater than or equal to maximumExclusive

isBetween

CharacterValidator isBetween(char minimum,
 boolean minimumIsInclusive,
 char maximum,
 boolean maximumIsInclusive)

Ensures that the value is within a range.

Parameters:

minimum - the lower bound of the range

minimumIsInclusive - true if the lower bound of the range is inclusive

maximum - the upper bound of the range

maximumIsInclusive - true if the upper bound of the range is inclusive

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if:

• minimum is greater than maximum
• minimumIsInclusive is true and the value is less than minimum
• minimumIsInclusive is false and the value is less than or equal to minimum
• maximumIsInclusive is true and the value is greater than maximum
• maximumInclusive is false and the value is greater than or equal to maximum