Module com.io7m.jaffirm.core

Package com.io7m.jaffirm.core

Class Postconditions

java.lang.Object

com.io7m.jaffirm.core.Postconditions

public final class Postconditions
extends Object

Functions to check postconditions.

Method Summary

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

checkPostconditions

@SafeVarargs
public static <T> T checkPostconditions(T value,
                                        ContractConditionType<T>... conditions)
                                 throws PostconditionViolationException

Evaluate all of the given conditions using value as input.

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

PostconditionViolationException - If any of the conditions are false

checkPostconditionsI

public static int checkPostconditionsI(int value,
                                       ContractIntConditionType... conditions)
                                throws PostconditionViolationException

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

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

PostconditionViolationException - If any of the conditions are false

checkPostconditionsL

public static long checkPostconditionsL(long value,
                                        ContractLongConditionType... conditions)
                                 throws PostconditionViolationException

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

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

PostconditionViolationException - If any of the conditions are false

checkPostconditionsD

public static double checkPostconditionsD(double value,
                                          ContractDoubleConditionType... conditions)
                                   throws PostconditionViolationException

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

Parameters:

value - The value

conditions - The conditions the value must obey

Returns:

value

Throws:

PostconditionViolationException - If any of the conditions are false

checkPostcondition

public static <T> T checkPostcondition(T value,
                                       ContractConditionType<T> condition)
                                throws PostconditionViolationException

Evaluate the given predicate using value as input.

The function throws PostconditionViolationException if the predicate is false.

Type Parameters:

T - The type of values

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostcondition

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

Evaluate the given predicate using value as input.

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

PostconditionViolationException - If the predicate is false

checkPostcondition

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

Evaluate the given predicate using value as input.

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

PostconditionViolationException - If the predicate is false

checkPostcondition

public static void checkPostcondition(boolean condition,
                                      String message)
                               throws PostconditionViolationException

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

Parameters:

condition - The predicate

message - The predicate description

Throws:

PostconditionViolationException - Iff predicate == false

checkPostcondition

public static void checkPostcondition(boolean condition,
                                      Supplier<String> message)
                               throws PostconditionViolationException

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

Parameters:

condition - The predicate

message - The predicate description supplier

Throws:

PostconditionViolationException - Iff predicate == false

checkPostconditionV

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

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

checkPostconditionV

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

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

checkPostconditionI

public static int checkPostconditionI(int value,
                                      ContractIntConditionType condition)
                               throws PostconditionViolationException

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

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionI

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

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

Parameters:

value - The value

predicate - The predicate

describer - The describer for the predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionI

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

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

Parameters:

value - The value

condition - The predicate

describer - The describer for the predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionL

public static long checkPostconditionL(long value,
                                       ContractLongConditionType condition)
                                throws PostconditionViolationException

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

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionL

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

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

Parameters:

value - The value

predicate - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionL

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

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

Parameters:

condition - The predicate

value - The value

describer - The describer of the predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionD

public static double checkPostconditionD(double value,
                                         ContractDoubleConditionType condition)
                                  throws PostconditionViolationException

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

Parameters:

value - The value

condition - The predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionD

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

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

Parameters:

value - The value

predicate - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false

checkPostconditionD

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

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

Parameters:

value - The value

condition - The predicate

describer - The describer of the predicate

Returns:

value

Throws:

PostconditionViolationException - If the predicate is false