Module com.io7m.jaffirm.core

Package com.io7m.jaffirm.core

Class Preconditions

java.lang.Object

com.io7m.jaffirm.core.Preconditions

public final class Preconditions
extends Object

Functions to check preconditions.

Method Summary

Modifier and Type	Method	Description
static void	checkPrecondition(boolean condition, String message)	A specialized version of checkPrecondition(Object, boolean, Function) that does not mention an input value.
static void	checkPrecondition(boolean condition, Supplier<String> message)	A specialized version of checkPrecondition(Object, boolean, Function) that does not mention an input value.
static <T> T	checkPrecondition(T value, boolean condition, Function<T,String> describer)	Evaluate the given predicate using value as input.
static <T> T	checkPrecondition(T value, ContractConditionType<T> condition)	Evaluate the given predicate using value as input.
static <T> T	checkPrecondition(T value, Predicate<T> predicate, Function<T,String> describer)	Evaluate the given predicate using value as input.
static double	checkPreconditionD(double value, boolean condition, DoubleFunction<String> describer)	A double specialized version of checkPrecondition(Object, boolean, Function)
static double	checkPreconditionD(double value, ContractDoubleConditionType condition)	A double specialized version of checkPrecondition(Object, ContractConditionType).
static double	checkPreconditionD(double value, DoublePredicate predicate, DoubleFunction<String> describer)	A double specialized version of checkPrecondition(Object, Predicate, Function)
static int	checkPreconditionI(int value, boolean condition, IntFunction<String> describer)	An int specialized version of checkPrecondition(Object, boolean, Function).
static int	checkPreconditionI(int value, ContractIntConditionType condition)	An int specialized version of checkPrecondition(Object, ContractConditionType).
static int	checkPreconditionI(int value, IntPredicate predicate, IntFunction<String> describer)	An int specialized version of checkPrecondition(Object, ContractConditionType).
static long	checkPreconditionL(long value, boolean condition, LongFunction<String> describer)	A long specialized version of checkPrecondition(Object, Predicate, Function)
static long	checkPreconditionL(long value, ContractLongConditionType condition)	A long specialized version of checkPrecondition(Object, ContractConditionType).
static long	checkPreconditionL(long value, LongPredicate predicate, LongFunction<String> describer)	A long specialized version of checkPrecondition(Object, Predicate, Function)
static <T> T	checkPreconditions(T value, ContractConditionType<T>... conditions)	Evaluate all of the given conditions using value as input.
static double	checkPreconditionsD(double value, ContractDoubleConditionType... conditions)	A double specialized version of checkPreconditions(Object, ContractConditionType[])
static int	checkPreconditionsI(int value, ContractIntConditionType... conditions)	An int specialized version of checkPreconditions(Object, ContractConditionType[])
static long	checkPreconditionsL(long value, ContractLongConditionType... conditions)	A long specialized version of checkPreconditions(Object, ContractConditionType[])
static void	checkPreconditionV(boolean condition, String format, Object... objects)	A version of checkPrecondition(boolean, String) that constructs a description message from the given format string and arguments.
static <T> T	checkPreconditionV(T value, boolean condition, String format, Object... objects)	A version of checkPrecondition(boolean, String) that constructs a description message from the given format string and arguments.

Methods inherited from class java.lang.Object

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

Method Detail

checkPreconditions

@SafeVarargs
public static <T> T checkPreconditions(T value,
                                       ContractConditionType<T>... conditions)
                                throws PreconditionViolationException

Evaluate all of the given conditions using value as input.

All of the conditions are evaluated and the function throws PreconditionViolationException if any of the conditions are false, or raise an exception that is not of type Error. Exceptions of type Error are propagated immediately, without any further contract checking.

Type Parameters:

T - The type of values

Parameters:

value - The value

conditions - The set of conditions

Returns:

value

Throws:

PreconditionViolationException - If any of the conditions are false

checkPreconditionsI

public static int checkPreconditionsI(int value,
                                      ContractIntConditionType... conditions)
                               throws PreconditionViolationException

An int specialized version of checkPreconditions(Object, ContractConditionType[])

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

PreconditionViolationException - If any of the conditions are false

checkPreconditionsL

public static long checkPreconditionsL(long value,
                                       ContractLongConditionType... conditions)
                                throws PreconditionViolationException

A long specialized version of checkPreconditions(Object, ContractConditionType[])

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

PreconditionViolationException - If any of the conditions are false

checkPreconditionsD

public static double checkPreconditionsD(double value,
                                         ContractDoubleConditionType... conditions)
                                  throws PreconditionViolationException

A double specialized version of checkPreconditions(Object, ContractConditionType[])

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

PreconditionViolationException - If any of the conditions are false

checkPrecondition

public static <T> T checkPrecondition(T value,
                                      ContractConditionType<T> condition)
                               throws PreconditionViolationException

Evaluate the given predicate using value as input.

The function throws PreconditionViolationException if the predicate is false.

Type Parameters:

T - The type of values

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPrecondition

public static <T> T checkPrecondition(T value,
                                      Predicate<T> predicate,
                                      Function<T,String> describer)

Evaluate the given predicate using value as input.

The function throws PreconditionViolationException if the predicate is false.

Type Parameters:

T - The type of values

Parameters:

value - The value

predicate - The predicate

describer - A describer for the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPrecondition

public static <T> T checkPrecondition(T value,
                                      boolean condition,
                                      Function<T,String> describer)

Evaluate the given predicate using value as input.

The function throws PreconditionViolationException if the predicate is false.

Type Parameters:

T - The type of values

Parameters:

value - The value

condition - The predicate

describer - A describer for the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPrecondition

public static void checkPrecondition(boolean condition,
                                     String message)
                              throws PreconditionViolationException

A specialized version of checkPrecondition(Object, boolean, Function) that does not mention an input value.

Parameters:

condition - The predicate

message - The predicate description

Throws:

PreconditionViolationException - Iff predicate == false

checkPrecondition

public static void checkPrecondition(boolean condition,
                                     Supplier<String> message)
                              throws PreconditionViolationException

A specialized version of checkPrecondition(Object, boolean, Function) that does not mention an input value.

Parameters:

condition - The predicate

message - The predicate description supplier

Throws:

PreconditionViolationException - Iff predicate == false

checkPreconditionV

public static <T> T checkPreconditionV(T value,
                                       boolean condition,
                                       String format,
                                       Object... objects)

A version of checkPrecondition(boolean, String) that constructs a description message from the given format string and arguments.

Note that the use of variadic arguments may entail allocating memory on virtual machines that fail to eliminate the allocations with escape analysis.

Type Parameters:

T - The precise type of values

Parameters:

value - The value

condition - The predicate

format - The format string

objects - The format string arguments

Returns:

value

Since:

1.1.0

checkPreconditionV

public static void checkPreconditionV(boolean condition,
                                      String format,
                                      Object... objects)

A version of checkPrecondition(boolean, String) that constructs a description message from the given format string and arguments.

Note that the use of variadic arguments may entail allocating memory on virtual machines that fail to eliminate the allocations with escape analysis.

Parameters:

condition - The predicate

format - The format string

objects - The format string arguments

Since:

1.1.0

checkPreconditionI

public static int checkPreconditionI(int value,
                                     ContractIntConditionType condition)
                              throws PreconditionViolationException

An int specialized version of checkPrecondition(Object, ContractConditionType).

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionI

public static int checkPreconditionI(int value,
                                     IntPredicate predicate,
                                     IntFunction<String> describer)

An int specialized version of checkPrecondition(Object, ContractConditionType).

Parameters:

value - The value

predicate - The predicate

describer - The describer for the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionI

public static int checkPreconditionI(int value,
                                     boolean condition,
                                     IntFunction<String> describer)

An int specialized version of checkPrecondition(Object, boolean, Function).

Parameters:

value - The value

condition - The predicate

describer - The describer for the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionL

public static long checkPreconditionL(long value,
                                      ContractLongConditionType condition)
                               throws PreconditionViolationException

A long specialized version of checkPrecondition(Object, ContractConditionType).

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionL

public static long checkPreconditionL(long value,
                                      LongPredicate predicate,
                                      LongFunction<String> describer)

A long specialized version of checkPrecondition(Object, Predicate, Function)

Parameters:

value - The value

predicate - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionL

public static long checkPreconditionL(long value,
                                      boolean condition,
                                      LongFunction<String> describer)

A long specialized version of checkPrecondition(Object, Predicate, Function)

Parameters:

condition - The predicate

value - The value

describer - The describer of the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionD

public static double checkPreconditionD(double value,
                                        ContractDoubleConditionType condition)
                                 throws PreconditionViolationException

A double specialized version of checkPrecondition(Object, ContractConditionType).

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionD

public static double checkPreconditionD(double value,
                                        DoublePredicate predicate,
                                        DoubleFunction<String> describer)

A double specialized version of checkPrecondition(Object, Predicate, Function)

Parameters:

value - The value

predicate - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false

checkPreconditionD

public static double checkPreconditionD(double value,
                                        boolean condition,
                                        DoubleFunction<String> describer)

A double specialized version of checkPrecondition(Object, boolean, Function)

Parameters:

value - The value

condition - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

PreconditionViolationException - If the predicate is false