Interface BigDecimalValidator

All Superinterfaces:

ComparableComponent<BigDecimalValidator, BigDecimal>, DecimalNumberComponent<BigDecimalValidator>, NegativeNumberComponent<BigDecimalValidator>, ObjectComponent<BigDecimalValidator, BigDecimal>, PositiveNumberComponent<BigDecimalValidator>, ValidatorComponent<BigDecimalValidator, BigDecimal>, ZeroNumberComponent<BigDecimalValidator>

public interface BigDecimalValidator
extends ValidatorComponent<BigDecimalValidator, BigDecimal>, ObjectComponent<BigDecimalValidator, BigDecimal>, NegativeNumberComponent<BigDecimalValidator>, PositiveNumberComponent<BigDecimalValidator>, ZeroNumberComponent<BigDecimalValidator>, ComparableComponent<BigDecimalValidator, BigDecimal>, DecimalNumberComponent<BigDecimalValidator>

Validates the state of a BigDecimal.

Method Summary

Modifier and Type	Method	Description
BigDecimalValidator	isMultipleOf(BigDecimal factor)	Ensures that the value is a multiple of factor.
BigDecimalValidator	isMultipleOf(BigDecimal factor, String name)	Ensures that the value is a multiple of factor.
BigDecimalValidator	isNotMultipleOf(BigDecimal factor)	Ensures that the value is not a multiple of factor.
BigDecimalValidator	isNotMultipleOf(BigDecimal factor, String name)	Ensures that the value is not a multiple of factor.
PrimitiveUnsignedIntegerValidator	precision()	Returns a validator for BigDecimal.precision().
PrimitiveIntegerValidator	scale()	Returns a validator for BigDecimal.scale().

Methods declared in interface ComparableComponent

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

Methods declared in interface DecimalNumberComponent

isNotWholeNumber, isWholeNumber

Methods declared in interface NegativeNumberComponent

isNegative, isNotNegative

Methods declared in interface ObjectComponent

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

Methods declared in interface PositiveNumberComponent

isNotPositive, isPositive

Methods declared in interface ValidatorComponent

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

Methods declared in interface ZeroNumberComponent

isNotZero, isZero

Method Details

isMultipleOf

BigDecimalValidator isMultipleOf(BigDecimal 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

BigDecimalValidator isMultipleOf(BigDecimal 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

BigDecimalValidator isNotMultipleOf(BigDecimal 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

BigDecimalValidator isNotMultipleOf(BigDecimal 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

precision

PrimitiveUnsignedIntegerValidator precision()

Returns a validator for BigDecimal.precision().

Returns:

a validator for BigDecimal.precision()

Throws:

NullPointerException - if the value is null

scale

PrimitiveIntegerValidator scale()

Returns a validator for BigDecimal.scale().

Returns:

a validator for BigDecimal.scale()

Throws:

NullPointerException - if the value is null