de.carne.check

Class Check

java.lang.Object

de.carne.check.Check

public final class Check
extends java.lang.Object

Utility class providing code check related functions.

Method Summary

Modifier and Type	Method and Description
static void	condition(boolean c) Check and ensure that a specific condition is met.
static void	condition(boolean c, java.lang.String message) Check and ensure that a specific condition is met.
static <T> T	fail() Throw an exception to indicate that an unexpected execution state occurred.
static <T> T	fail(java.lang.String message) Throw an exception to indicate that an unexpected execution state occurred.
static <T> T	nonNull(T o) Check and ensure that an object is not null.
static <T> T	nonNull(T o, java.lang.String message) Check and ensure that an object is not null.

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(@Nullable
                            T o)
                     throws java.lang.NullPointerException

Check and ensure that an object is not null.

Type Parameters:

T - The actual object type.

Parameters:

o - The object to check.

Returns:

The checked object (never null).

Throws:

java.lang.NullPointerException - if the submitted argument is null.

nonNull

public static <T> T nonNull(@Nullable
                            T o,
                            java.lang.String message)
                     throws java.lang.NullPointerException

Check and ensure that an object is not null.

Type Parameters:

T - The actual object type.

Parameters:

o - The object to check.

message - The message to issue if the check fails.

Returns:

The checked object (never null).

Throws:

java.lang.NullPointerException - if the submitted argument is null.

condition

public static void condition(boolean c)
                      throws java.lang.IllegalStateException

Check and ensure that a specific condition is met.

Parameters:

c - The condition to check.

Throws:

java.lang.IllegalStateException - if the condition is not met.

condition

public static void condition(boolean c,
                             java.lang.String message)
                      throws java.lang.IllegalStateException

Check and ensure that a specific condition is met.

Parameters:

c - The condition to check.

message - The message to issue if the check fails.

Throws:

java.lang.IllegalStateException - if the condition is not met.

fail

public static <T> T fail()
                  throws java.lang.IllegalStateException

Throw an exception to indicate that an unexpected execution state occurred.

Type Parameters:

T - The generic return type.

Returns:

Nothing (function never returns).

Throws:

java.lang.IllegalStateException - any time this function is called.

fail

public static <T> T fail(java.lang.String message)
                  throws java.lang.IllegalStateException

Throw an exception to indicate that an unexpected execution state occurred.

Type Parameters:

T - The generic return type.

Parameters:

message - The message to issue if the check fails.

Returns:

Nothing (function never returns).

Throws:

java.lang.IllegalStateException - any time this function is called.