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	assertTrue(boolean condition) Check and ensure that a specific condition is met.
static void	assertTrue(boolean condition, java.lang.String message) Check and ensure that a specific condition is met.
static <T> T	fail() Throw an IllegalStateException to indicate that an unexpected execution state occurred.
static <T> T	fail(java.lang.String message) Throw an IllegalStateException to indicate that an unexpected execution state occurred.
static <T> T	notNull(T object) Check and ensure that an Object is not null.
static <T> T	notNull(T object, 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

notNull

public static <T> T notNull(@Nullable
                            T object)

Check and ensure that an Object is not null.

Type Parameters:

T - The actual object type.

Parameters:

object - The Object to check.

Returns:

The checked Object (never null).

Throws:

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

notNull

public static <T> T notNull(@Nullable
                            T object,
                            java.lang.String message)

Check and ensure that an Object is not null.

Type Parameters:

T - The actual object type.

Parameters:

object - 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.

assertTrue

public static void assertTrue(boolean condition)

Check and ensure that a specific condition is met.

Parameters:

condition - The condition to check.

Throws:

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

assertTrue

public static void assertTrue(boolean condition,
                              java.lang.String message)

Check and ensure that a specific condition is met.

Parameters:

condition - 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()

Throw an IllegalStateException 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)

Throw an IllegalStateException 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.