de.skuzzle.tinyplugz.util

Class Require

java.lang.Object

de.skuzzle.tinyplugz.util.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 <T> T	nonNull(T obj) Asserts that the given object is non null.
static <T> T	nonNull(T obj, String paramName) Asserts that the given object is non null.
static <T> T	nonNullResult(T result, String call) Asserts that a method call yielded a non-null result.
static <T extends Exception> void	state(boolean state, Function<String,T> excpetionCtor, String message, Object format) Asserts that the given condition holds true and throws a custom exception if not.
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 <T> T nonNull(T obj,
                            String paramName)

Asserts that the given object is non null.

Type Parameters:

T - Type of the object to test.

Parameters:

obj - The object to test.

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

Returns:

The object.

Throws:

IllegalArgumentException - If obj is null.

nonNull

public static <T> T nonNull(T obj)

Asserts that the given object is non null.

Type Parameters:

T - Type of the object to test.

Parameters:

obj - The object to test.

Returns:

The object.

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.

state

public static <T extends Exception> void state(boolean state,
                                               Function<String,T> excpetionCtor,
                                               String message,
                                               Object format)
                                        throws T extends Exception

Asserts that the given condition holds true and throws a custom exception if not.

Parameters:

state - The condition to check.

excpetionCtor - Constructor of the exception to throw.

message - String for exception message.

format - Formatting parameters for the exception message.

Throws:

T - If condition is false.

T extends Exception

Since:

0.2.0

nonNullResult

public static <T> T nonNullResult(T result,
                                  String call)

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

Type Parameters:

T - Type of the object to test.

Parameters:

result - The result object.

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

Returns:

The object which was passed in.

Throws:

IllegalStateException - If result is null.