Module id.xfunction

Package id.xfunction

Class Preconditions

Object

Preconditions

public class Preconditions
extends Object

Set of assertions

Constructor Summary

Constructors

Constructor	Description
Preconditions()

Method Summary

Modifier and Type	Method	Description
static void	equals(double expected, double actual)	Preconditional check for equality.
static void	equals(double expected, double actual, TracingToken token, String msg)
static void	equals(double expected, double actual, String msg)	Preconditional check for equality with custom additional message
static void	equals(long expected, long actual)	Preconditional check for equality.
static void	equals(long expected, long actual, TracingToken token, String msg)
static void	equals(long expected, long actual, String msg)	Preconditional check for equality with custom additional message
static <T> void	equals(T expected, T actual)	Preconditional check for equality.
static <T> void	equals(T expected, T actual, TracingToken token, String msg)
static <T> void	equals(T expected, T actual, TracingToken token, String msg, Object... param)
static <T> void	equals(T expected, T actual, String msg)	Preconditional check for equality with custom additional message
static <T> void	equals(T expected, T actual, String msg, Object... param)	Preconditional check for equality with custom additional message
static void	isLess(long lesser, long greater, TracingToken token, String message)
static void	isLess(long lesser, long greater, String message)	Preconditional check for comparison.
static void	isLessOrEqual(long lesser, long greater, TracingToken token, String message)
static void	isLessOrEqual(long lesser, long greater, String message)	Preconditional check for comparison.
static void	isNull(Object obj)	Preconditional check for null objects.
static void	isNull(Object obj, TracingToken token, String message, Object... param)
static void	isNull(Object obj, String message, Object... param)	Preconditional check for null objects.
static void	isTrue(boolean b)	Preconditional check.
static void	isTrue(boolean b, TracingToken token, String message, Object... param)
static void	isTrue(boolean b, String message, Object... param)	Preconditional check.
static void	notNull(Object obj)	Preconditional check for null objects.
static void	notNull(Object obj, TracingToken token, String message, Object... param)
static void	notNull(Object obj, String message, Object... param)	Preconditional check for null objects.

Methods inherited from class Object

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

Constructor Details

Preconditions

public Preconditions()

Method Details

notNull

public static void notNull(Object obj)
                    throws PreconditionException

Preconditional check for null objects.

Throws:

PreconditionException - if obj is null

notNull

public static void notNull(Object obj,
 String message,
 Object... param)
                    throws PreconditionException

Preconditional check for null objects.

Throws:

PreconditionException - with a message if obj is null

notNull

public static void notNull(Object obj,
 TracingToken token,
 String message,
 Object... param)
                    throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• notNull(Object, String, Object...)

isNull

public static void isNull(Object obj)
                   throws PreconditionException

Preconditional check for null objects.

Throws:

PreconditionException - if obj is not null

isNull

public static void isNull(Object obj,
 String message,
 Object... param)
                   throws PreconditionException

Preconditional check for null objects.

Throws:

PreconditionException - with a message if obj is not null

isNull

public static void isNull(Object obj,
 TracingToken token,
 String message,
 Object... param)
                   throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• isNull(Object, String, Object...)

isTrue

public static void isTrue(boolean b)
                   throws PreconditionException

Preconditional check.

Throws:

PreconditionException - if b is false

isTrue

public static void isTrue(boolean b,
 String message,
 Object... param)
                   throws PreconditionException

Preconditional check.

Throws:

PreconditionException - with a message if b is false

isTrue

public static void isTrue(boolean b,
 TracingToken token,
 String message,
 Object... param)
                   throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• isTrue(boolean, String, Object...)

equals

public static void equals(long expected,
 long actual)
                   throws PreconditionException

Preconditional check for equality.

Throws:

PreconditionException - if two values are not equal

equals

public static void equals(long expected,
 long actual,
 String msg)
                   throws PreconditionException

Preconditional check for equality with custom additional message

Throws:

PreconditionException - if two values are not equal

equals

public static void equals(long expected,
 long actual,
 TracingToken token,
 String msg)
                   throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• equals(long, long, String)

equals

public static void equals(double expected,
 double actual)
                   throws PreconditionException

Preconditional check for equality.

Throws:

PreconditionException - if two values are not equal

equals

public static void equals(double expected,
 double actual,
 String msg)
                   throws PreconditionException

Preconditional check for equality with custom additional message

Throws:

PreconditionException - if two values are not equal

equals

public static void equals(double expected,
 double actual,
 TracingToken token,
 String msg)
                   throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• equals(double, double, String)

equals

public static <T> void equals(T expected,
 T actual)
                       throws PreconditionException

Preconditional check for equality.

Throws:

PreconditionException - if two values are not equal

equals

public static <T> void equals(T expected,
 T actual,
 String msg)
                       throws PreconditionException

Preconditional check for equality with custom additional message

Throws:

PreconditionException - if two values are not equal

equals

public static <T> void equals(T expected,
 T actual,
 TracingToken token,
 String msg)
                       throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• equals(Object, Object, String)

equals

public static <T> void equals(T expected,
 T actual,
 String msg,
 Object... param)
                       throws PreconditionException

Preconditional check for equality with custom additional message

Throws:

PreconditionException - if two values are not equal

equals

public static <T> void equals(T expected,
 T actual,
 TracingToken token,
 String msg,
 Object... param)
                       throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• equals(Object, Object, String)

isLess

public static void isLess(long lesser,
 long greater,
 String message)
                   throws PreconditionException

Preconditional check for comparison.

Throws:

PreconditionException - if two values are not equal

isLess

public static void isLess(long lesser,
 long greater,
 TracingToken token,
 String message)
                   throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• isLess(long, long, String)

isLessOrEqual

public static void isLessOrEqual(long lesser,
 long greater,
 String message)
                          throws PreconditionException

Preconditional check for comparison.

Throws:

PreconditionException - if two values are not equal

isLessOrEqual

public static void isLessOrEqual(long lesser,
 long greater,
 TracingToken token,
 String message)
                          throws PreconditionException

Parameters:

token - helps to establish not only stack trace but the object for which precondition failed

Throws:

PreconditionException

See Also:

• isLessOrEqual(long, long, String)