Module com.github.cowwoc.requirements10.java

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

Interface LongValidator

All Superinterfaces:

ComparableComponent<LongValidator,Long>, NegativeNumberComponent<LongValidator>, ObjectComponent<LongValidator,Long>, PositiveNumberComponent<LongValidator>, ValidatorComponent<LongValidator,Long>, ZeroNumberComponent<LongValidator>

public interface LongValidator
extends ValidatorComponent<LongValidator,Long>, NegativeNumberComponent<LongValidator>, ZeroNumberComponent<LongValidator>, PositiveNumberComponent<LongValidator>, ObjectComponent<LongValidator,Long>, ComparableComponent<LongValidator,Long>

Validates the state of a Long.

Method Summary

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

LongValidator isMultipleOf(long 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

LongValidator isMultipleOf(long 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

LongValidator isNotMultipleOf(long 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

LongValidator isNotMultipleOf(long 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

LongValidator isLessThan(long 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

LongValidator isLessThan(long 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

LongValidator isLessThanOrEqualTo(long 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

LongValidator isLessThanOrEqualTo(long 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

LongValidator isGreaterThanOrEqualTo(long 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

LongValidator isGreaterThanOrEqualTo(long 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

LongValidator isGreaterThan(long 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

LongValidator isGreaterThan(long 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

LongValidator isBetween(long minimumInclusive,
 long 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

LongValidator isBetween(long minimum,
 boolean minimumIsInclusive,
 long 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