Module com.io7m.jaffirm.core

Package com.io7m.jaffirm.core

Class Invariants

java.lang.Object

com.io7m.jaffirm.core.Invariants

public final class Invariants
extends Object

Functions to check invariants.

Method Summary

Modifier and Type	Method	Description
static void	checkInvariant(boolean condition, String message)	A specialized version of checkInvariant(Object, boolean, Function) that does not mention an input value.
static void	checkInvariant(boolean condition, Supplier<String> message)	A specialized version of checkInvariant(Object, boolean, Function) that does not mention an input value.
static <T> T	checkInvariant(T value, boolean condition, Function<T,String> describer)	Evaluate the given predicate using value as input.
static <T> T	checkInvariant(T value, ContractConditionType<T> condition)	Evaluate the given predicate using value as input.
static <T> T	checkInvariant(T value, Predicate<T> predicate, Function<T,String> describer)	Evaluate the given predicate using value as input.
static double	checkInvariantD(double value, boolean condition, DoubleFunction<String> describer)	A double specialized version of checkInvariant(Object, boolean, Function)
static double	checkInvariantD(double value, ContractDoubleConditionType condition)	A double specialized version of checkInvariant(Object, ContractConditionType).
static double	checkInvariantD(double value, DoublePredicate predicate, DoubleFunction<String> describer)	A double specialized version of checkInvariant(Object, Predicate, Function)
static int	checkInvariantI(int value, boolean condition, IntFunction<String> describer)	An int specialized version of checkInvariant(Object, boolean, Function).
static int	checkInvariantI(int value, ContractIntConditionType condition)	An int specialized version of checkInvariant(Object, ContractConditionType).
static int	checkInvariantI(int value, IntPredicate predicate, IntFunction<String> describer)	An int specialized version of checkInvariant(Object, ContractConditionType).
static long	checkInvariantL(long value, boolean condition, LongFunction<String> describer)	A long specialized version of checkInvariant(Object, Predicate, Function)
static long	checkInvariantL(long value, ContractLongConditionType condition)	A long specialized version of checkInvariant(Object, ContractConditionType).
static long	checkInvariantL(long value, LongPredicate predicate, LongFunction<String> describer)	A long specialized version of checkInvariant(Object, Predicate, Function)
static <T> T	checkInvariants(T value, ContractConditionType<T>... conditions)	Evaluate all of the given conditions using value as input.
static double	checkInvariantsD(double value, ContractDoubleConditionType... conditions)	A double specialized version of checkInvariants(Object, ContractConditionType[])
static int	checkInvariantsI(int value, ContractIntConditionType... conditions)	An int specialized version of checkInvariants(Object, ContractConditionType[])
static long	checkInvariantsL(long value, ContractLongConditionType... conditions)	A long specialized version of checkInvariants(Object, ContractConditionType[])
static void	checkInvariantV(boolean condition, String format, Object... objects)	A version of checkInvariant(boolean, String) that constructs a description message from the given format string and arguments.
static <T> T	checkInvariantV(T value, boolean condition, String format, Object... objects)	A version of checkInvariant(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

checkInvariants

@SafeVarargs
public static <T> T checkInvariants(T value,
                                    ContractConditionType<T>... conditions)
                             throws InvariantViolationException

Evaluate all of the given conditions using value as input.

All of the conditions are evaluated and the function throws InvariantViolationException 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:

InvariantViolationException - If any of the conditions are false

checkInvariantsI

public static int checkInvariantsI(int value,
                                   ContractIntConditionType... conditions)
                            throws InvariantViolationException

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

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

InvariantViolationException - If any of the conditions are false

checkInvariantsL

public static long checkInvariantsL(long value,
                                    ContractLongConditionType... conditions)
                             throws InvariantViolationException

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

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

InvariantViolationException - If any of the conditions are false

checkInvariantsD

public static double checkInvariantsD(double value,
                                      ContractDoubleConditionType... conditions)
                               throws InvariantViolationException

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

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

InvariantViolationException - If any of the conditions are false

checkInvariant

public static <T> T checkInvariant(T value,
                                   ContractConditionType<T> condition)
                            throws InvariantViolationException

Evaluate the given predicate using value as input.

The function throws InvariantViolationException if the predicate is false.

Type Parameters:

T - The type of values

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariant

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

Evaluate the given predicate using value as input.

The function throws InvariantViolationException 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:

InvariantViolationException - If the predicate is false

checkInvariant

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

Evaluate the given predicate using value as input.

The function throws InvariantViolationException 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:

InvariantViolationException - If the predicate is false

checkInvariant

public static void checkInvariant(boolean condition,
                                  String message)
                           throws InvariantViolationException

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

Parameters:

condition - The predicate

message - The predicate description

Throws:

InvariantViolationException - Iff predicate == false

checkInvariant

public static void checkInvariant(boolean condition,
                                  Supplier<String> message)
                           throws InvariantViolationException

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

Parameters:

condition - The predicate

message - The predicate description supplier

Throws:

InvariantViolationException - Iff predicate == false

checkInvariantV

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

A version of checkInvariant(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

checkInvariantV

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

A version of checkInvariant(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

checkInvariantI

public static int checkInvariantI(int value,
                                  ContractIntConditionType condition)
                           throws InvariantViolationException

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

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantI

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

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

Parameters:

value - The value

predicate - The predicate

describer - The describer for the predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantI

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

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

Parameters:

value - The value

condition - The predicate

describer - The describer for the predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantL

public static long checkInvariantL(long value,
                                   ContractLongConditionType condition)
                            throws InvariantViolationException

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

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantL

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

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

Parameters:

value - The value

predicate - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantL

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

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

Parameters:

condition - The predicate

value - The value

describer - The describer of the predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantD

public static double checkInvariantD(double value,
                                     ContractDoubleConditionType condition)
                              throws InvariantViolationException

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

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantD

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

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

Parameters:

value - The value

predicate - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false

checkInvariantD

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

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

Parameters:

value - The value

condition - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

InvariantViolationException - If the predicate is false