net.sf.staccatocommons.check
Class Ensure

java.lang.Object
  net.sf.staccatocommons.check.Ensure

public final class Ensure
extends Object

Ensure is a utility class for performing precondition checks. This class is a singleton, and offers static utility methods to perform validations directly through it single instance

Author:

fbulgarelli

Method Summary

static <A> A	fail(String message, Object... args) Shortcut to Ensure.that().fail(message,args)
static <A> A	fail(String varName, Object var, String message, Object... args) Shortcut to Ensure.that().fail(varName,var,message,args)
static void	isNotNull(String variableName, Object variable) Shortcut to Ensure.that().isNotNull(variableName, variable)
static void	isNull(String variableName, Object variable) Shortcut to Ensure.that().isNull(variableName, variable)
static Check<IllegalArgumentException>	that()
static void	that(boolean condition, String message, Object... messageArgs) Shortcut to Ensure.that().is(condition,message,args)
static void	thatVar(String varName, Object var, boolean condition, String message, Object... messageArgs) Shortcut to Ensure.that().is(varName,var,condition,message,args)

Methods inherited from class java.lang.Object

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

Method Detail

fail

public static <A> A fail(String varName,
                         Object var,
                         String message,
                         Object... args)

Shortcut to Ensure.that().fail(varName,var,message,args)

See Also:

Check.failVar(String, Object, String, Object...)

fail

public static <A> A fail(String message,
                         Object... args)

Shortcut to Ensure.that().fail(message,args)

See Also:

Check.fail(String, Object...)

thatVar

public static void thatVar(String varName,
                           Object var,
                           boolean condition,
                           String message,
                           Object... messageArgs)

Shortcut to Ensure.that().is(varName,var,condition,message,args)

See Also:

Check.thatVar(String, Object, boolean, String, Object...)

that

public static void that(boolean condition,
                        String message,
                        Object... messageArgs)

Shortcut to Ensure.that().is(condition,message,args)

See Also:

Check.that(boolean, String, Object...)

isNotNull

public static void isNotNull(String variableName,
                             Object variable)

Shortcut to Ensure.that().isNotNull(variableName, variable)

See Also:

Check.isNotNull(String, Object)

isNull

public static void isNull(String variableName,
                          Object variable)

Shortcut to Ensure.that().isNull(variableName, variable)

See Also:

Check.isNull(String, Object)

that

public static Check<IllegalArgumentException> that()

Returns:

a singleton Check that throws IllegalArgumentExceptions on check failure