com.io7m.jranges

Class RangeCheck

java.lang.Object

com.io7m.jranges.RangeCheck

@EqualityReference
public final class RangeCheck
extends Object

Functions for enforcing range constraints at run time.

The functions are intended for use in the manner of assertions. That is, the program should behave identically if all of the checks are removed. The functions raise RangeCheckException upon failure. Exceptions of this type are not intended to be caught and handled; they indicate program bugs.

See Also:

RangeCheckException

Field Summary

Fields

Modifier and Type	Field and Description
static RangeInclusiveD	NATURAL_DOUBLE The inclusive range of numbers greater than or equal to 0, [0, Double.MAX_VALUE].
static RangeInclusiveL	NATURAL_INTEGER The inclusive range of natural integers, [0, Integer.MAX_VALUE].
static RangeInclusiveD	POSITIVE_DOUBLE The inclusive range of numbers greater than or equal to 1, [1, Double.MAX_VALUE].
static RangeInclusiveL	POSITIVE_INTEGER The inclusive range of positive integers, [1, Integer.MAX_VALUE].

Method Summary

Methods

Modifier and Type	Method and Description
static long	checkGreater(long x, String x_name, long in_lower, String lower_name) Assert that x (named x_name) is greater than in_lower (named lower_name).
static BigInteger	checkGreaterBig(BigInteger x, String x_name, BigInteger in_lower, String lower_name) Assert that x (named x_name) is greater than in_lower (named lower_name).
static double	checkGreaterDouble(double x, String x_name, double in_lower, String lower_name) Assert that x (named x_name) is greater than in_lower (named lower_name).
static long	checkGreaterEqual(long x, String x_name, long in_lower, String lower_name) Assert that x (named x_name) is greater than or equal to in_lower (named lower_name).
static BigInteger	checkGreaterEqualBig(BigInteger x, String x_name, BigInteger in_lower, String lower_name) Assert that x (named x_name) is greater than or equal to in_lower (named lower_name).
static double	checkGreaterEqualDouble(double x, String x_name, double in_lower, String lower_name) Assert that x (named x_name) is greater than or equal to in_lower (named lower_name).
static long	checkIncludedIn(long x, String x_name, RangeInclusiveL range, String range_name) Assert that x (named x_name) is included in the given range range (named range_name).
static BigInteger	checkIncludedInBig(BigInteger x, String x_name, RangeInclusiveB range, String range_name) Assert that x (named x_name) is included in the given range range (named range_name).
static long	checkLess(long x, String x_name, long in_upper, String upper_name) Assert that x (named x_name) is less than in_upper (named upper_name).
static BigInteger	checkLessBig(BigInteger x, String x_name, BigInteger in_upper, String upper_name) Assert that x (named x_name) is less than in_upper (named upper_name).
static double	checkLessDouble(double x, String x_name, double in_upper, String upper_name) Assert that x (named x_name) is less than in_upper (named upper_name).
static long	checkLessEqual(long x, String x_name, long in_upper, String upper_name) Assert that x (named x_name) is less than or equal to in_upper (named upper_name).
static BigInteger	checkLessEqualBig(BigInteger x, String x_name, BigInteger in_upper, String upper_name) Assert that x (named x_name) is less than or equal to in_upper (named upper_name).
static double	checkLessEqualDouble(double x, String x_name, double in_upper, String upper_name) Assert that x (named x_name) is less than or equal to in_upper (named upper_name).
static RangeInclusiveL	checkRangeIncludedIn(RangeInclusiveL inner, String inner_name, RangeInclusiveL outer, String outer_name) Assert that inner (named inner_name) is included in the given range outer (named outer_name).
static RangeInclusiveB	checkRangeIncludedInBig(RangeInclusiveB inner, String inner_name, RangeInclusiveB outer, String outer_name) Assert that inner (named inner_name) is included in the given range outer (named outer_name).

Methods inherited from class java.lang.Object

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

Field Detail

NATURAL_DOUBLE

public static final RangeInclusiveD NATURAL_DOUBLE

The inclusive range of numbers greater than or equal to 0, [0, Double.MAX_VALUE].

NATURAL_INTEGER

public static final RangeInclusiveL NATURAL_INTEGER

The inclusive range of natural integers, [0, Integer.MAX_VALUE].

POSITIVE_DOUBLE

public static final RangeInclusiveD POSITIVE_DOUBLE

The inclusive range of numbers greater than or equal to 1, [1, Double.MAX_VALUE].

POSITIVE_INTEGER

public static final RangeInclusiveL POSITIVE_INTEGER

The inclusive range of positive integers, [1, Integer.MAX_VALUE].

Method Detail

checkGreater

public static long checkGreater(long x,
                String x_name,
                long in_lower,
                String lower_name)

Assert that x (named x_name) is greater than in_lower (named lower_name).

Parameters:

x - The checked value

in_lower - The lower bound

x_name - The name of the checked value

lower_name - The name of the lower bound

Returns:

x

checkGreaterBig

public static BigInteger checkGreaterBig(BigInteger x,
                         String x_name,
                         BigInteger in_lower,
                         String lower_name)

Assert that x (named x_name) is greater than in_lower (named lower_name).

Parameters:

x - The checked value

in_lower - The lower bound

x_name - The name of the checked value

lower_name - The name of the lower bound

Returns:

x

checkGreaterDouble

public static double checkGreaterDouble(double x,
                        String x_name,
                        double in_lower,
                        String lower_name)

Assert that x (named x_name) is greater than in_lower (named lower_name).

Parameters:

x - The checked value

in_lower - The lower bound

x_name - The name of the checked value

lower_name - The name of the lower bound

Returns:

x

checkGreaterEqual

public static long checkGreaterEqual(long x,
                     String x_name,
                     long in_lower,
                     String lower_name)

Assert that x (named x_name) is greater than or equal to in_lower (named lower_name).

Parameters:

x - The checked value

in_lower - The lower bound

x_name - The name of x

lower_name - The name of the lower bound

Returns:

x

checkGreaterEqualBig

public static BigInteger checkGreaterEqualBig(BigInteger x,
                              String x_name,
                              BigInteger in_lower,
                              String lower_name)

Assert that x (named x_name) is greater than or equal to in_lower (named lower_name).

Parameters:

x - The checked value

in_lower - The lower bound

x_name - The name of the checked value

lower_name - The name of the lower bound

Returns:

x

checkGreaterEqualDouble

public static double checkGreaterEqualDouble(double x,
                             String x_name,
                             double in_lower,
                             String lower_name)

Assert that x (named x_name) is greater than or equal to in_lower (named lower_name).

Parameters:

x - The checked value

in_lower - The lower bound

x_name - The name of x

lower_name - The name of the lower bound

Returns:

x

checkIncludedIn

public static long checkIncludedIn(long x,
                   String x_name,
                   RangeInclusiveL range,
                   String range_name)

Assert that x (named x_name) is included in the given range range (named range_name).

Parameters:

x - The checked value

x_name - The name of the checked value

range - The inclusive range

range_name - The name of the inclusive range

Returns:

x

checkIncludedInBig

public static BigInteger checkIncludedInBig(BigInteger x,
                            String x_name,
                            RangeInclusiveB range,
                            String range_name)

Assert that x (named x_name) is included in the given range range (named range_name).

Parameters:

x - The checked value

x_name - The name of the checked value

range - The inclusive range

range_name - The name of the inclusive range

Returns:

x

checkLess

public static long checkLess(long x,
             String x_name,
             long in_upper,
             String upper_name)

Assert that x (named x_name) is less than in_upper (named upper_name).

Parameters:

x - The checked value

in_upper - The upper bound

x_name - The name of the checked value

upper_name - The name of the upper bound

Returns:

x

checkLessBig

public static BigInteger checkLessBig(BigInteger x,
                      String x_name,
                      BigInteger in_upper,
                      String upper_name)

Assert that x (named x_name) is less than in_upper (named upper_name).

Parameters:

x - The checked value

in_upper - The upper bound

x_name - The name of the checked value

upper_name - The name of the upper bound

Returns:

x

checkLessDouble

public static double checkLessDouble(double x,
                     String x_name,
                     double in_upper,
                     String upper_name)

Assert that x (named x_name) is less than in_upper (named upper_name).

Parameters:

x - The checked value

in_upper - The upper bound

x_name - The name of the checked value

upper_name - The name of the upper bound

Returns:

x

checkLessEqual

public static long checkLessEqual(long x,
                  String x_name,
                  long in_upper,
                  String upper_name)

Assert that x (named x_name) is less than or equal to in_upper (named upper_name).

Parameters:

x - The checked value

in_upper - The upper bound

x_name - The name of x

upper_name - The name of the upper bound

Returns:

x

checkLessEqualBig

public static BigInteger checkLessEqualBig(BigInteger x,
                           String x_name,
                           BigInteger in_upper,
                           String upper_name)

Assert that x (named x_name) is less than or equal to in_upper (named upper_name).

Parameters:

x - The checked value

in_upper - The upper bound

x_name - The name of the checked value

upper_name - The name of the upper bound

Returns:

x

checkLessEqualDouble

public static double checkLessEqualDouble(double x,
                          String x_name,
                          double in_upper,
                          String upper_name)

Assert that x (named x_name) is less than or equal to in_upper (named upper_name).

Parameters:

x - The checked value

in_upper - The upper bound

x_name - The name of x

upper_name - The name of the upper bound

Returns:

x

checkRangeIncludedIn

public static RangeInclusiveL checkRangeIncludedIn(RangeInclusiveL inner,
                                   String inner_name,
                                   RangeInclusiveL outer,
                                   String outer_name)

Assert that inner (named inner_name) is included in the given range outer (named outer_name).

Parameters:

inner - The checked range

inner_name - The name of the checked range

outer - The outer range

outer_name - The name of the outer range

Returns:

inner

checkRangeIncludedInBig

public static RangeInclusiveB checkRangeIncludedInBig(RangeInclusiveB inner,
                                      String inner_name,
                                      RangeInclusiveB outer,
                                      String outer_name)

Assert that inner (named inner_name) is included in the given range outer (named outer_name).

Parameters:

inner - The checked range

inner_name - The name of the checked range

outer - The outer range

outer_name - The name of the outer range

Returns:

inner