Module com.github.cowwoc.requirements10.java

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

Interface ShortValidator

All Superinterfaces:

ComparableComponent<ShortValidator,Short>, NegativeNumberComponent<ShortValidator>, ObjectComponent<ShortValidator,Short>, PositiveNumberComponent<ShortValidator>, ValidatorComponent<ShortValidator,Short>, ZeroNumberComponent<ShortValidator>

public interface ShortValidator
extends ValidatorComponent<ShortValidator,Short>, NegativeNumberComponent<ShortValidator>, ZeroNumberComponent<ShortValidator>, PositiveNumberComponent<ShortValidator>, ObjectComponent<ShortValidator,Short>, ComparableComponent<ShortValidator,Short>

Validates the state of a Short.

Method Summary

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

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.NegativeNumberComponent

isNegative, isNotNegative

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.PositiveNumberComponent

isNotPositive, isPositive

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

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

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

isNotZero, isZero

Method Details

isMultipleOf

ShortValidator isMultipleOf(short factor)

Ensures that the value is a multiple of factor.

Parameters:

factor - the number being multiplied

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not a multiple of factor

isMultipleOf

ShortValidator isMultipleOf(short factor,
 String name)

Ensures that the value is a multiple of factor.

Parameters:

factor - the number being multiplied

name - the name of the factor

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 not a multiple of factor

isNotMultipleOf

ShortValidator isNotMultipleOf(short factor)

Ensures that the value is not a multiple of factor.

Parameters:

factor - the number being multiplied

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is a multiple of factor

isNotMultipleOf

ShortValidator isNotMultipleOf(short factor,
 String name)

Ensures that the value is not a multiple of factor.

Parameters:

factor - the number being multiplied

name - the name of the factor

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 a multiple of factor

isLessThan

ShortValidator isLessThan(short 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

ShortValidator isLessThan(short 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

ShortValidator isLessThanOrEqualTo(short 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

ShortValidator isLessThanOrEqualTo(short 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

ShortValidator isGreaterThanOrEqualTo(short 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

ShortValidator isGreaterThanOrEqualTo(short 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

ShortValidator isGreaterThan(short 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

ShortValidator isGreaterThan(short 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

ShortValidator isBetween(short minimumInclusive,
 short 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 less than minimumInclusive
• the value is greater than or equal to maximumExclusive

isBetween

ShortValidator isBetween(short minimum,
 boolean minimumIsInclusive,
 short 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
• maximumIsInclusive is false and the value is greater than or equal to maximum