org.bitbucket.cowwoc.requirements.spi

Interface ComparableRequirementsSpi<S extends ComparableRequirementsSpi<S,T>,T extends Comparable<? super T>>

Type Parameters:

S - the type of the non-SPI interface extending this interface

T - the type of the parameter

All Superinterfaces:

ObjectRequirementsSpi<S,T>

All Known Subinterfaces:

BigDecimalPrecisionRequirements, BigDecimalRequirements, BigDecimalScaleRequirements, CollectionSizeRequirements, ComparableRequirements<T>, MapSizeRequirements, NumberRequirements<T>, NumberRequirementsSpi<S,T>, PrimitiveIntegerRequirementsSpi<S>, StringLengthRequirements

public interface ComparableRequirementsSpi<S extends ComparableRequirementsSpi<S,T>,T extends Comparable<? super T>>
extends ObjectRequirementsSpi<S,T>

Verifies requirements of a Comparable.

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
S	isGreaterThan(T value) Ensures that the parameter is greater than a constant.
S	isGreaterThan(T value, String name) Ensures that the parameter is greater than a variable.
S	isGreaterThanOrEqualTo(T value) Ensures that the parameter is greater than or bigger than a constant.
S	isGreaterThanOrEqualTo(T value, String name) Ensures that the parameter is greater than or bigger than a variable.
S	isIn(Range<T> range) Ensures that the parameter is within range.
S	isLessThan(T value) Ensures that the parameter is less than a constant.
S	isLessThan(T value, String name) Ensures that the parameter is less than the value of a variable.
S	isLessThanOrEqualTo(T value) Ensures that the parameter is less than or equal to a constant.
S	isLessThanOrEqualTo(T value, String name) Ensures that the parameter is less than or equal to a variable.

Methods inherited from interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

isEqualTo, isEqualTo, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotNull, isNull, withContext, withException

Method Detail

isGreaterThan

S isGreaterThan(T value,
                String name)
         throws NullPointerException,
                IllegalArgumentException

Ensures that the parameter is greater than a variable.

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

S isGreaterThan(T value)
         throws NullPointerException,
                IllegalArgumentException

Ensures that the parameter is greater than a constant.

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

S isGreaterThanOrEqualTo(T value,
                         String name)
                  throws NullPointerException,
                         IllegalArgumentException

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

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

S isGreaterThanOrEqualTo(T value)
                  throws NullPointerException,
                         IllegalArgumentException

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

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

S isLessThan(T value,
             String name)
      throws NullPointerException,
             IllegalArgumentException

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

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

S isLessThan(T value)
      throws NullPointerException,
             IllegalArgumentException

Ensures that the parameter is less than a constant.

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

S isLessThanOrEqualTo(T value,
                      String name)
               throws NullPointerException,
                      IllegalArgumentException

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

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

S isLessThanOrEqualTo(T value)
               throws NullPointerException,
                      IllegalArgumentException

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

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

S isIn(Range<T> range)
throws NullPointerException,
       IllegalArgumentException

Ensures that the parameter is within range.

Parameters:

range - the range

Returns:

this

Throws:

NullPointerException - if range is null

IllegalArgumentException - if parameter is not in range