org.apache.isis.core.commons.ensure

Class Ensure

java.lang.Object

org.apache.isis.core.commons.ensure.Ensure

public final class Ensure
extends Object

Uses the Hamcrest API as a means of verifying arguments and so on.

Method Summary

Methods

Modifier and Type	Method and Description
static void	ensure(String expectation, boolean expression) To ensure that the provided assertion is true
static <T> T	ensureThatArg(T object, org.hamcrest.Matcher<T> matcher) To ensure that the provided argument is correct.
static <T> T	ensureThatArg(T arg, org.hamcrest.Matcher<T> matcher, String message) To ensure that the provided argument is correct.
static <T> T	ensureThatContext(T contextProperty, org.hamcrest.Matcher<T> matcher) To ensure that the current context (IsisContext) is correct.
static <T> T	ensureThatContext(T contextProperty, org.hamcrest.Matcher<T> matcher, String message) To ensure that the current context (IsisContext) is correct.
static <T> T	ensureThatState(T field, org.hamcrest.Matcher<T> matcher) To ensure that the current state of this object (instance fields) is correct.
static <T> T	ensureThatState(T field, org.hamcrest.Matcher<T> matcher, String message) To ensure that the current state of this object (instance fields) is correct.

Methods inherited from class java.lang.Object

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

Method Detail

ensure

public static void ensure(String expectation,
          boolean expression)

To ensure that the provided assertion is true

Throws:

IllegalArgumentException

ensureThatArg

public static <T> T ensureThatArg(T object,
                  org.hamcrest.Matcher<T> matcher)

To ensure that the provided argument is correct.

Throws:

IllegalArgumentException - if matcher does not match.

See Also:

#ensureThatArg(Object, Matcher,State), ensureThatState(Object, Matcher, String), ensureThatContext(Object, Matcher)

ensureThatArg

public static <T> T ensureThatArg(T arg,
                  org.hamcrest.Matcher<T> matcher,
                  String message)

To ensure that the provided argument is correct.

Throws:

IllegalArgumentException - if matcher does not match.

See Also:

ensureThatArg(Object, Matcher), ensureThatState(Object, Matcher, String), ensureThatContext(Object, Matcher)

ensureThatState

public static <T> T ensureThatState(T field,
                    org.hamcrest.Matcher<T> matcher)

To ensure that the current state of this object (instance fields) is correct.

Throws:

IllegalStateException - if matcher does not match.

See Also:

ensureThatArg(Object, Matcher), ensureThatContext(Object, Matcher), ensureThatState(Object, Matcher, String)

ensureThatState

public static <T> T ensureThatState(T field,
                    org.hamcrest.Matcher<T> matcher,
                    String message)

To ensure that the current state of this object (instance fields) is correct.

Throws:

IllegalStateException - if matcher does not match.

See Also:

ensureThatArg(Object, Matcher), ensureThatContext(Object, Matcher), ensureThatState(Object, Matcher)

ensureThatContext

public static <T> T ensureThatContext(T contextProperty,
                      org.hamcrest.Matcher<T> matcher)

To ensure that the current context (IsisContext) is correct.

Throws:

IllegalThreadStateException - if matcher does not match.

See Also:

ensureThatArg(Object, Matcher), ensureThatState(Object, Matcher), ensureThatContext(Object, Matcher, String)

ensureThatContext

public static <T> T ensureThatContext(T contextProperty,
                      org.hamcrest.Matcher<T> matcher,
                      String message)

To ensure that the current context (IsisContext) is correct.

Throws:

IllegalThreadStateException - if matcher does not match.

See Also:

ensureThatArg(Object, Matcher), ensureThatState(Object, Matcher), ensureThatContext(Object, Matcher, String)