Module com.github.cowwoc.requirements10.java

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

Interface BigIntegerValidator

All Superinterfaces:

ComparableComponent<BigIntegerValidator,BigInteger>, NegativeNumberComponent<BigIntegerValidator>, ObjectComponent<BigIntegerValidator,BigInteger>, PositiveNumberComponent<BigIntegerValidator>, ValidatorComponent<BigIntegerValidator,BigInteger>, ZeroNumberComponent<BigIntegerValidator>

public interface BigIntegerValidator
extends ValidatorComponent<BigIntegerValidator,BigInteger>, ObjectComponent<BigIntegerValidator,BigInteger>, NegativeNumberComponent<BigIntegerValidator>, ZeroNumberComponent<BigIntegerValidator>, PositiveNumberComponent<BigIntegerValidator>, ComparableComponent<BigIntegerValidator,BigInteger>

Validates the state of a BigInteger.

Method Summary

Modifier and Type	Method	Description
BigIntegerValidator	isMultipleOf(BigInteger factor)	Ensures that the value is a multiple of factor.
BigIntegerValidator	isMultipleOf(BigInteger factor, String name)	Ensures that the value is a multiple of factor.
BigIntegerValidator	isNotMultipleOf(BigInteger factor)	Ensures that the value is not a multiple of factor.
BigIntegerValidator	isNotMultipleOf(BigInteger 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

BigIntegerValidator isMultipleOf(BigInteger factor)

Ensures that the value is a multiple of factor.

Parameters:

factor - the number being multiplied

Returns:

this

Throws:

NullPointerException - if the value or factor are null

IllegalArgumentException - if the value is not a multiple of factor

isMultipleOf

BigIntegerValidator isMultipleOf(BigInteger 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 any of the arguments 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

BigIntegerValidator isNotMultipleOf(BigInteger factor)

Ensures that the value is not a multiple of factor.

Parameters:

factor - the number being multiplied

Returns:

this

Throws:

NullPointerException - if the value or factor are null

IllegalArgumentException - if the value is a multiple of factor

isNotMultipleOf

BigIntegerValidator isNotMultipleOf(BigInteger 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 any of the arguments 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