org.bitbucket.cowwoc.requirements

Class DoubleRequirementsImpl

java.lang.Object

org.bitbucket.cowwoc.requirements.DoubleRequirementsImpl

All Implemented Interfaces:

DoubleRequirements, Isolatable<DoubleRequirements>, org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>, org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>, org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>, Verifier

public final class DoubleRequirementsImpl
extends Object
implements DoubleRequirements

Default implementation of DoubleRequirements.

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
DoubleRequirements	addContext(String key, Object value) Appends contextual information to the exception message.
DoubleRequirements	isEqualTo(Double value) Ensures that the parameter is equal to a value.
DoubleRequirements	isEqualTo(Double value, String name) Ensures that the parameter is equal to a variable.
DoubleRequirements	isFinite() Ensures that the parameter is finite.
DoubleRequirements	isGreaterThan(Double value) Ensures that the parameter is greater than a constant.
DoubleRequirements	isGreaterThan(Double value, String name) Ensures that the parameter is greater than a variable.
DoubleRequirements	isGreaterThanOrEqualTo(Double value) Ensures that the parameter is greater than or bigger than a constant.
DoubleRequirements	isGreaterThanOrEqualTo(Double value, String name) Ensures that the parameter is greater than or bigger than a variable.
DoubleRequirements	isIn(Collection<Double> collection) Ensures that a collection contains the parameter.
DoubleRequirements	isIn(Double first, Double last) Ensures that the parameter is within range.
DoubleRequirements	isIn(Range<Double> range) Deprecated.
DoubleRequirements	isInstanceOf(Class<?> type) Ensures that the parameter is an instance of a class.
DoubleRequirements	isLessThan(Double value) Ensures that the parameter is less than a constant.
DoubleRequirements	isLessThan(Double value, String name) Ensures that the parameter is less than the value of a variable.
DoubleRequirements	isLessThanOrEqualTo(Double value) Ensures that the parameter is less than or equal to a constant.
DoubleRequirements	isLessThanOrEqualTo(Double value, String name) Ensures that the parameter is less than or equal to a variable.
DoubleRequirements	isNegative() Ensures that the parameter is negative.
DoubleRequirements	isNotEqualTo(Double value) Ensures that the parameter is not equal to a value.
DoubleRequirements	isNotEqualTo(Double value, String name) Ensures that the parameter is not equal to a variable.
DoubleRequirements	isNotFinite() Ensures that the parameter is not finite.
DoubleRequirements	isNotNegative() Ensures that the parameter is not negative.
DoubleRequirements	isNotNull() Ensures that the parameter is not null.
DoubleRequirements	isNotNumber() Ensures that the parameter is not a number.
DoubleRequirements	isNotPositive() Ensures that the parameter is not positive.
DoubleRequirements	isNotZero() Ensures that the parameter is not zero.
DoubleRequirements	isNull() Ensures that the parameter is null.
DoubleRequirements	isNumber() Ensures that the parameter is a number.
DoubleRequirements	isolate(Consumer<DoubleRequirements> consumer) Verifies requirements without modifying the current instance.
DoubleRequirements	isPositive() Ensures that the parameter is positive.
DoubleRequirements	isZero() Ensures that the parameter is zero.
DoubleRequirements	withContext(List<Map.Entry<String,Object>> context) Sets the contextual information to append to the exception message.
DoubleRequirements	withException(Class<? extends RuntimeException> exception) Overrides the type of exception that will get thrown if a requirement fails.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withException

public DoubleRequirements withException(Class<? extends RuntimeException> exception)

Description copied from interface: Verifier

Overrides the type of exception that will get thrown if a requirement fails.

The exception class must define the following constructors:

<init>(String message)
<init>(String message, Throwable cause)

Specified by:

withException in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Specified by:

withException in interface Verifier

Parameters:

exception - the type of exception to throw, null to throw the default exception type

Returns:

a verifier with the specified exception override

addContext

public DoubleRequirements addContext(String key,
                                     Object value)

Description copied from interface: Verifier

Appends contextual information to the exception message.

Specified by:

addContext in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Specified by:

addContext in interface Verifier

Parameters:

key - a key

value - a value

Returns:

a verifier with the specified context

withContext

public DoubleRequirements withContext(List<Map.Entry<String,Object>> context)
                               throws NullPointerException

Description copied from interface: Verifier

Sets the contextual information to append to the exception message.

Specified by:

withContext in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Specified by:

withContext in interface Verifier

Parameters:

context - the contextual information

Returns:

a verifier with the specified context

Throws:

NullPointerException - if context is null

isNegative

public DoubleRequirements isNegative()
                              throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi

Ensures that the parameter is negative.

Specified by:

isNegative in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is not negative

isNotNegative

public DoubleRequirements isNotNegative()
                                 throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi

Ensures that the parameter is not negative.

Specified by:

isNotNegative in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is negative

isNotPositive

public DoubleRequirements isNotPositive()
                                 throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi

Ensures that the parameter is not positive.

Specified by:

isNotPositive in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is positive

isNotZero

public DoubleRequirements isNotZero()
                             throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi

Ensures that the parameter is not zero.

Specified by:

isNotZero in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is zero

isPositive

public DoubleRequirements isPositive()
                              throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi

Ensures that the parameter is positive.

Specified by:

isPositive in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is not positive

isZero

public DoubleRequirements isZero()
                          throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi

Ensures that the parameter is zero.

Specified by:

isZero in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is not zero

isGreaterThan

public DoubleRequirements isGreaterThan(Double value,
                                        String name)
                                 throws NullPointerException,
                                        IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is greater than a variable.

Specified by:

isGreaterThan in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be greater than

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if value or name are null

IllegalArgumentException - if parameter is less than or equal to value; if name is empty

isGreaterThan

public DoubleRequirements isGreaterThan(Double value)
                                 throws NullPointerException,
                                        IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is greater than a constant.

Specified by:

isGreaterThan in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be greater than

Returns:

this

Throws:

NullPointerException - if value is null

IllegalArgumentException - if parameter is less than or equal to value

isGreaterThanOrEqualTo

public DoubleRequirements isGreaterThanOrEqualTo(Double value,
                                                 String name)
                                          throws NullPointerException,
                                                 IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is greater than or bigger than a variable.

Specified by:

isGreaterThanOrEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be greater than or equal to

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if value or name are null

IllegalArgumentException - if parameter is less than to value; if name is empty

isGreaterThanOrEqualTo

public DoubleRequirements isGreaterThanOrEqualTo(Double value)
                                          throws NullPointerException,
                                                 IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is greater than or bigger than a constant.

Specified by:

isGreaterThanOrEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be greater than or equal to

Returns:

this

Throws:

NullPointerException - if value is null

IllegalArgumentException - if parameter is less than to value

isLessThan

public DoubleRequirements isLessThan(Double value,
                                     String name)
                              throws NullPointerException,
                                     IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is less than the value of a variable.

Specified by:

isLessThan in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be less than

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if value or name are null

IllegalArgumentException - if parameter is greater than or equal to value; if name is empty

isLessThan

public DoubleRequirements isLessThan(Double value)
                              throws NullPointerException,
                                     IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is less than a constant.

Specified by:

isLessThan in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be less than

Returns:

this

Throws:

NullPointerException - if value is null

IllegalArgumentException - if parameter is greater than or equal to value

isLessThanOrEqualTo

public DoubleRequirements isLessThanOrEqualTo(Double value,
                                              String name)
                                       throws NullPointerException,
                                              IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is less than or equal to a variable.

Specified by:

isLessThanOrEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be less than or equal to

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if value or name are null

IllegalArgumentException - if parameter is greater than value; if name is empty

isLessThanOrEqualTo

public DoubleRequirements isLessThanOrEqualTo(Double value)
                                       throws NullPointerException,
                                              IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is less than or equal to a constant.

Specified by:

isLessThanOrEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value the parameter must be less than or equal to

Returns:

this

Throws:

NullPointerException - if value is null

IllegalArgumentException - if parameter is greater than value

isIn

@Deprecated
public DoubleRequirements isIn(Range<Double> range)
                                     throws NullPointerException,
                                            IllegalArgumentException

Deprecated.

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is within range.

Specified by:

isIn in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

range - the range

Returns:

this

Throws:

NullPointerException - if range is null

IllegalArgumentException - if parameter is not in range

isIn

public DoubleRequirements isIn(Double first,
                               Double last)
                        throws NullPointerException,
                               IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi

Ensures that the parameter is within range.

Specified by:

isIn in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<DoubleRequirements,Double>

Parameters:

first - the first element in the range

last - the last element in the range

Returns:

this

Throws:

NullPointerException - if first or last are null

IllegalArgumentException - if last is less than first; if parameter is not in range

isEqualTo

public DoubleRequirements isEqualTo(Double value)
                             throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is equal to a value.

Specified by:

isEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value to compare to

Returns:

this

Throws:

IllegalArgumentException - if parameter is not equal to value

See Also:

An explanation of the output format

isEqualTo

public DoubleRequirements isEqualTo(Double value,
                                    String name)
                             throws NullPointerException,
                                    IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is equal to a variable.

Specified by:

isEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value to compare to

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if name is null

IllegalArgumentException - if parameter is not equal to the variable; if name is empty

See Also:

An explanation of the output format

isNotEqualTo

public DoubleRequirements isNotEqualTo(Double value)
                                throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is not equal to a value.

Specified by:

isNotEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value to compare to

Returns:

this

Throws:

IllegalArgumentException - if parameter is equal to value

isNotEqualTo

public DoubleRequirements isNotEqualTo(Double value,
                                       String name)
                                throws NullPointerException,
                                       IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is not equal to a variable.

Specified by:

isNotEqualTo in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Parameters:

value - the value to compare to

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if name is null

IllegalArgumentException - if parameter is equal to the variable; if name is empty

isIn

public DoubleRequirements isIn(Collection<Double> collection)
                        throws NullPointerException,
                               IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that a collection contains the parameter.

Specified by:

isIn in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Parameters:

collection - a collection

Returns:

this

Throws:

NullPointerException - if collection is null

IllegalArgumentException - if collection does not contain parameter

isInstanceOf

public DoubleRequirements isInstanceOf(Class<?> type)
                                throws NullPointerException,
                                       IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is an instance of a class.

Specified by:

isInstanceOf in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Parameters:

type - the class to compare to

Returns:

this

Throws:

NullPointerException - if type are null

IllegalArgumentException - if parameter is not an instance of type

isNull

public DoubleRequirements isNull()
                          throws IllegalArgumentException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is null.

Specified by:

isNull in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

IllegalArgumentException - if parameter is not null

isNotNull

public DoubleRequirements isNotNull()
                             throws NullPointerException

Description copied from interface: org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

Ensures that the parameter is not null.

Specified by:

isNotNull in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<DoubleRequirements,Double>

Returns:

this

Throws:

NullPointerException - if parameter is null

isNumber

public DoubleRequirements isNumber()
                            throws IllegalArgumentException

Description copied from interface: DoubleRequirements

Ensures that the parameter is a number.

Specified by:

isNumber in interface DoubleRequirements

Returns:

this

Throws:

IllegalArgumentException - if parameter is not a number

See Also:

Double.isNaN()

isNotNumber

public DoubleRequirements isNotNumber()
                               throws IllegalArgumentException

Description copied from interface: DoubleRequirements

Ensures that the parameter is not a number.

Specified by:

isNotNumber in interface DoubleRequirements

Returns:

this

Throws:

IllegalArgumentException - if parameter is a number

See Also:

Double.isNaN()

isFinite

public DoubleRequirements isFinite()
                            throws IllegalArgumentException

Description copied from interface: DoubleRequirements

Ensures that the parameter is finite.

Specified by:

isFinite in interface DoubleRequirements

Returns:

this

Throws:

IllegalArgumentException - if parameter is not finite

See Also:

Double.isInfinite()

isNotFinite

public DoubleRequirements isNotFinite()
                               throws IllegalArgumentException

Description copied from interface: DoubleRequirements

Ensures that the parameter is not finite.

Specified by:

isNotFinite in interface DoubleRequirements

Returns:

this

Throws:

IllegalArgumentException - if parameter is finite

See Also:

Double.isInfinite()

isolate

public DoubleRequirements isolate(Consumer<DoubleRequirements> consumer)

Description copied from interface: Isolatable

Verifies requirements without modifying the current instance. This can be used to combine requirements that operate on nested elements:

 Map<String, Integer> nameToId = ...;
 Requirements.requireThat(nameToId, "nameToId").keySet().contains("John Smith");
 Requirements.requireThat(nameToId, "nameToId").values().doesNotContain(0, "RESERVED_ID");

 // Can be rewritten as:
 Requirements.requireThat(nameToId, "nameToId").
   isolate(p -> p.keySet().contains("John Smith")).
   isolate(p -> p.values().doesNotContain(0, "RESERVED_ID"));
 

Specified by:

isolate in interface Isolatable<DoubleRequirements>

Parameters:

consumer - the code to execute in isolation

Returns:

this