org.kocakosm.pitaya.util

Class Parameters

java.lang.Object

org.kocakosm.pitaya.util.Parameters

public final class Parameters
extends Object

Utility class to test parameters validity.

Author:

Osman KOCAK

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkCondition(boolean condition) Checks the truth of the given condition checking parameters validity.
static void	checkCondition(boolean condition, String msg, Object... args) Checks the truth of the given condition checking parameters validity.
static <T> T	checkNotNull(T ref) Checks that the given reference is not null and returns it in case of success.
static <T> T	checkNotNull(T ref, String msg, Object... args) Checks that the given reference is not null and returns it in case of success.
static <T> T	checkType(Object ref, Class<T> type) Checks the type of the given reference and, in case of success, casts and returns it.
static <T> T	checkType(Object ref, Class<T> type, String msg, Object... args) Checks the type of the given reference and, in case of success, casts and returns it.

Methods inherited from class java.lang.Object

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

Method Detail

checkNotNull

public static <T> T checkNotNull(T ref)

Checks that the given reference is not null and returns it in case of success.

Type Parameters:

T - the type of the given reference.

Parameters:

ref - the reference to test.

Returns:

the validated (non-null) reference.

Throws:

NullPointerException - if the given reference is null.

checkNotNull

public static <T> T checkNotNull(T ref,
                 String msg,
                 Object... args)

Checks that the given reference is not null and returns it in case of success.

Type Parameters:

T - the type of the given reference.

Parameters:

ref - the reference to test.

msg - the error message format string.

args - the error message arguments.

Returns:

the validated (non-null) reference.

Throws:

NullPointerException - if the given reference is null.

checkCondition

public static void checkCondition(boolean condition)

Checks the truth of the given condition checking parameters validity.

Parameters:

condition - the boolean condition to test.

Throws:

IllegalArgumentException - if the condition is false.

checkCondition

public static void checkCondition(boolean condition,
                  String msg,
                  Object... args)

Checks the truth of the given condition checking parameters validity.

Parameters:

condition - the boolean condition to test.

msg - the error message format string.

args - the error message arguments.

Throws:

IllegalArgumentException - if the condition is false.

checkType

public static <T> T checkType(Object ref,
              Class<T> type)

Checks the type of the given reference and, in case of success, casts and returns it.

Type Parameters:

T - the expected type of the given reference.

Parameters:

ref - the reference to test.

type - the expected type of the given reference.

Returns:

the given reference in the expected type.

Throws:

NullPointerException - if type is null.

ClassCastException - if the given reference doesn't represent an instance of the expected class.

checkType

public static <T> T checkType(Object ref,
              Class<T> type,
              String msg,
              Object... args)

Checks the type of the given reference and, in case of success, casts and returns it.

Type Parameters:

T - the expected type of the given reference.

Parameters:

ref - the reference to test.

type - the expected type of the given reference.

msg - the error message format string.

args - the error message arguments.

Returns:

the given reference in the expected type.

Throws:

NullPointerException - if type is null.

ClassCastException - if the given reference doesn't represent an instance of the given class.