Package org.sellcom.core

Class Contract

java.lang.Object

org.sellcom.core.Contract

public class Contract
extends java.lang.Object

Operations for checking method contracts.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static <T extends java.lang.RuntimeException> void	check(boolean condition, java.lang.Class<T> exceptionType)	Checks the given contract condition.
static <T extends java.lang.RuntimeException> void	check(boolean condition, java.lang.Class<T> exceptionType, java.lang.String message, java.lang.Object... arguments)	Checks the given contract condition.
static void	checkArgument(boolean condition, java.lang.String message, java.lang.Object... arguments)	Checks the given contract condition of one or more input parameters of the calling method.
static void	checkState(boolean condition, java.lang.String message, java.lang.Object... arguments)	Checks the given contract condition of the calling object's state.

Methods inherited from class java.lang.Object

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

Method Detail

check

public static <T extends java.lang.RuntimeException> void check(boolean condition,
                                                                java.lang.Class<T> exceptionType)

Checks the given contract condition. Throws an exception of the given type with no message if the check fails.

Throws:

java.lang.IllegalArgumentException - if exceptionType is null

java.lang.IllegalArgumentException - if exceptionType could not be instantiated

Since:

1.0

check

public static <T extends java.lang.RuntimeException> void check(boolean condition,
                                                                java.lang.Class<T> exceptionType,
                                                                java.lang.String message,
                                                                java.lang.Object... arguments)

Checks the given contract condition. Throws an exception of the given type with the given message if the check fails. Interpolates the given arguments into the message using MessageFormat if any.

Throws:

java.lang.IllegalArgumentException - if exceptionType is null

java.lang.IllegalArgumentException - if exceptionType could not be instantiated

Since:

1.0

checkArgument

public static void checkArgument(boolean condition,
                                 java.lang.String message,
                                 java.lang.Object... arguments)

Checks the given contract condition of one or more input parameters of the calling method. Throws an IllegalArgumentException with the given message if the check fails. Interpolates the given arguments into the message using MessageFormat if any.

Since:

1.0

checkState

public static void checkState(boolean condition,
                              java.lang.String message,
                              java.lang.Object... arguments)

Checks the given contract condition of the calling object's state. Throws an IllegalStateException with the given message if the check fails. Interpolates the given arguments into the message using MessageFormat if any.

Since:

1.0