Module com.speedment.common.invariant

Package com.speedment.common.invariant

Class IntRangeUtil

java.lang.Object

com.speedment.common.invariant.IntRangeUtil

public final class IntRangeUtil
extends Object

Utility class for checking invariants on int-values.

Author:

Emil Forslund

Method Summary

Modifier and Type	Method	Description
static int	requireEquals(int val, int otherVal)
static <E extends RuntimeException> int	requireEquals(int val, int otherVal, Function<String,E> exceptionConstructor)
static int	requireInRange(int val, int first, int lastExclusive)
static <E extends RuntimeException> int	requireInRange(int val, int first, int lastExclusive, Function<String,E> exceptionConstructor)
static int	requireInRangeClosed(int val, int first, int lastInclusive)
static <E extends RuntimeException> int	requireInRangeClosed(int val, int first, int lastInclusive, Function<String,E> exceptionConstructor)
static int	requireNegative(int val)
static <E extends RuntimeException> int	requireNegative(int val, Function<String,E> exceptionConstructor)
static int	requireNonNegative(int val)
static <E extends RuntimeException> int	requireNonNegative(int val, Function<String,E> exceptionConstructor)
static int	requireNonPositive(int val)
static <E extends RuntimeException> int	requireNonPositive(int val, Function<String,E> exceptionConstructor)
static int	requireNonZero(int val)
static <E extends RuntimeException> int	requireNonZero(int val, Function<String,E> exceptionConstructor)
static int	requireNotEquals(int val, int otherVal)
static <E extends RuntimeException> int	requireNotEquals(int val, int otherVal, Function<String,E> exceptionConstructor)
static int	requirePositive(int val)	Returns the given value if it is positive.
static <E extends RuntimeException> int	requirePositive(int val, Function<String,E> exceptionConstructor)	Returns the given value if it is positive.
static int	requireZero(int val)
static <E extends RuntimeException> int	requireZero(int val, Function<String,E> exceptionConstructor)

Methods inherited from class java.lang.Object

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

Method Detail

requirePositive

public static int requirePositive(int val)

Returns the given value if it is positive.

Parameters:

val - to check

Returns:

the given value

Throws:

IllegalArgumentException - if the given value is not positive

requireNegative

public static int requireNegative(int val)

requireZero

public static int requireZero(int val)

requireNonPositive

public static int requireNonPositive(int val)

requireNonNegative

public static int requireNonNegative(int val)

requireNonZero

public static int requireNonZero(int val)

requireEquals

public static int requireEquals(int val,
                                int otherVal)

requireNotEquals

public static int requireNotEquals(int val,
                                   int otherVal)

requireInRange

public static int requireInRange(int val,
                                 int first,
                                 int lastExclusive)

requireInRangeClosed

public static int requireInRangeClosed(int val,
                                       int first,
                                       int lastInclusive)

requirePositive

public static <E extends RuntimeException> int requirePositive(int val,
                                                               Function<String,E> exceptionConstructor)

Returns the given value if it is positive.

Type Parameters:

E - RuntimeException type

Parameters:

val - to check

exceptionConstructor - to use when throwing exception

Returns:

the given value

Throws:

RuntimeException - if the given value is not positive

requireNegative

public static <E extends RuntimeException> int requireNegative(int val,
                                                               Function<String,E> exceptionConstructor)

requireZero

public static <E extends RuntimeException> int requireZero(int val,
                                                           Function<String,E> exceptionConstructor)

requireNonPositive

public static <E extends RuntimeException> int requireNonPositive(int val,
                                                                  Function<String,E> exceptionConstructor)

requireNonNegative

public static <E extends RuntimeException> int requireNonNegative(int val,
                                                                  Function<String,E> exceptionConstructor)

requireNonZero

public static <E extends RuntimeException> int requireNonZero(int val,
                                                              Function<String,E> exceptionConstructor)

requireEquals

public static <E extends RuntimeException> int requireEquals(int val,
                                                             int otherVal,
                                                             Function<String,E> exceptionConstructor)

requireNotEquals

public static <E extends RuntimeException> int requireNotEquals(int val,
                                                                int otherVal,
                                                                Function<String,E> exceptionConstructor)

requireInRange

public static <E extends RuntimeException> int requireInRange(int val,
                                                              int first,
                                                              int lastExclusive,
                                                              Function<String,E> exceptionConstructor)

requireInRangeClosed

public static <E extends RuntimeException> int requireInRangeClosed(int val,
                                                                    int first,
                                                                    int lastInclusive,
                                                                    Function<String,E> exceptionConstructor)