Module com.github.cowwoc.requirements10.java

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

Interface FloatValidator

All Superinterfaces:

ComparableComponent<FloatValidator,Float>, DecimalNumberComponent<FloatValidator>, FixedPrecisionDecimalNumberComponent<FloatValidator>, NegativeNumberComponent<FloatValidator>, ObjectComponent<FloatValidator,Float>, PositiveNumberComponent<FloatValidator>, ValidatorComponent<FloatValidator,Float>, ZeroNumberComponent<FloatValidator>

public interface FloatValidator
extends ValidatorComponent<FloatValidator,Float>, ObjectComponent<FloatValidator,Float>, NegativeNumberComponent<FloatValidator>, ZeroNumberComponent<FloatValidator>, PositiveNumberComponent<FloatValidator>, FixedPrecisionDecimalNumberComponent<FloatValidator>, DecimalNumberComponent<FloatValidator>, ComparableComponent<FloatValidator,Float>

Validates the state of a Float.

Method Summary

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

isNotWholeNumber, isWholeNumber

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

isFinite, isInfinite, isNotNumber, isNumber

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

FloatValidator isMultipleOf(float 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
• not a number

isMultipleOf

FloatValidator isMultipleOf(float 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
• the value is not a number

isNotMultipleOf

FloatValidator isNotMultipleOf(float 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

FloatValidator isNotMultipleOf(float 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

FloatValidator isLessThan(float 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
• not a number

isLessThan

FloatValidator isLessThan(float 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
• the value is not a number

isLessThanOrEqualTo

FloatValidator isLessThanOrEqualTo(float 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
• not a number

isLessThanOrEqualTo

FloatValidator isLessThanOrEqualTo(float 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
• the value is not a number

isGreaterThanOrEqualTo

FloatValidator isGreaterThanOrEqualTo(float 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
• not a number

isGreaterThanOrEqualTo

FloatValidator isGreaterThanOrEqualTo(float 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
• the value is not a number

isGreaterThan

FloatValidator isGreaterThan(float 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
• not a number

isGreaterThan

FloatValidator isGreaterThan(float 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
• the value is not a number

isBetween

FloatValidator isBetween(float minimumInclusive,
 float 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
• the value is not a number

isBetween

FloatValidator isBetween(float minimum,
 boolean minimumIsInclusive,
 float 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
• the value is not a number