de.skuzzle.tinyplugz

Class Require

java.lang.Object

de.skuzzle.tinyplugz.Require

public final class Require
extends Object

Utility class for checking parameters and states.

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
static void	condition(boolean condition, String message, Object... format) Asserts that the given condition holds true.
static void	nonNull(Object obj, String paramName) Asserts that the given object is non null.
static void	nonNullResult(Object result, String call) Asserts that a method call yielded a non-null result.
static void	state(boolean state, String message, Object... format) Asserts that the given condition holds true.

Methods inherited from class java.lang.Object

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

Method Detail

nonNull

public static void nonNull(Object obj,
                           String paramName)

Asserts that the given object is non null.

Parameters:

obj - The object to test.

paramName - The name of the parameter (used for exception message).

Throws:

IllegalArgumentException - If obj is null.

condition

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

Asserts that the given condition holds true.

Parameters:

condition - The condition to check.

message - String for the exception message.

format - Formatting parameters for the exception message.

Throws:

IllegalArgumentException - If condition is false.

state

public static void state(boolean state,
                         String message,
                         Object... format)

Asserts that the given condition holds true.

Parameters:

state - The condition to check.

message - String for the exception message.

format - Formatting parameters for the exception message.

Throws:

IllegalStateException - If condition is false.

nonNullResult

public static void nonNullResult(Object result,
                                 String call)

Asserts that a method call yielded a non-null result.

Parameters:

result - The result object.

call - A String description of the call, like "Object.calledMethod".

Throws:

IllegalStateException - If result is null.