org.aerogear.mobile.core.utils

Class SanityCheck

java.lang.Object

org.aerogear.mobile.core.utils.SanityCheck

public final class SanityCheck
extends java.lang.Object

Utility class used to check that passed in parameters complies to specific rules.

Method Summary

Modifier and Type	Method and Description
static <T,K> T	isA(T value, java.lang.Class<K> clazz, java.lang.String paramName) Checks that value is of type K.
static <T,K> T	isA(T value, java.lang.Class<K> clazz, java.lang.String customMessage, java.lang.Object... params) Checks that value is of type K.
static java.lang.String	nonEmpty(java.lang.String value, boolean trim, java.lang.String customMessage, java.lang.Object... params) Checks if the passed in value is an empty String.
static java.lang.String	nonEmpty(java.lang.String value, java.lang.String paramName) Checks if the passed in value is an empty string.
static java.lang.String	nonEmpty(java.lang.String value, java.lang.String paramName, boolean trim) Checks if the passed in value is an empty string.
static java.lang.String	nonEmpty(java.lang.String value, java.lang.String customMessage, java.lang.Object... params) Checks if the passed in value is an empty String.
static <T> T	nonNull(T value, java.lang.String paramName) Checks that the passed in value is not null.
static <T> T	nonNull(T value, java.lang.String customMessage, java.lang.Object... params) Checks that the passed in value 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(T value,
                            java.lang.String paramName)

Checks that the passed in value is not null. If it is null, a NullPointerException is thrown with a message specifying that the parameter can't be null.

Type Parameters:

T - the type parameter of the value under test

Parameters:

value - current value

paramName - parameter name

Returns:

current value

nonNull

public static <T> T nonNull(T value,
                            java.lang.String customMessage,
                            java.lang.Object... params)

Checks that the passed in value is not null. If it is, a NullPointerException is thrown with message customMessage. If the custom message is a pattern, params will be applied to that pattern

Type Parameters:

T - the type parameter of the value under test

Parameters:

value - current value

customMessage - message to be put inside the NullPointerException. Can be a pattern.

params - parameters to be applied to the customMessage pattern

Returns:

the current value

See Also:

String.format(String, Object...)

nonEmpty

public static java.lang.String nonEmpty(java.lang.String value,
                                        java.lang.String paramName)

Checks if the passed in value is an empty string. The string gets trimmed. If it is empty, an IllegalArgumentException gets thrown with an appropriate error message.

Parameters:

value - string to be checked

paramName - parameter name to be used in the error message

Returns:

the received param

nonEmpty

public static java.lang.String nonEmpty(java.lang.String value,
                                        java.lang.String paramName,
                                        boolean trim)

Checks if the passed in value is an empty string. if trim is true, the string gets trimmed. If it is empty, an IllegalArgumentException gets thrown with an appropriate error message.

Parameters:

value - string to be checked

paramName - parameter name to be used in the error message

trim - whether the string must be trimmed or not

Returns:

the received value

nonEmpty

public static java.lang.String nonEmpty(java.lang.String value,
                                        java.lang.String customMessage,
                                        java.lang.Object... params)

Checks if the passed in value is an empty String. If it is empty an IllegalArgumentException is thrown with the passed in custom message. The params are applied to the customMessage according to String.format

Parameters:

value - string to be checked

customMessage - custom message to be put into the exception

params - parameters to be applied to the custom message

Returns:

checked string

See Also:

String.format(String, Object...)

nonEmpty

public static java.lang.String nonEmpty(java.lang.String value,
                                        boolean trim,
                                        java.lang.String customMessage,
                                        java.lang.Object... params)

Checks if the passed in value is an empty String. If it is empty an IllegalArgumentException is thrown with the passed in custom message. The params are applied to the customMessage according to String.format

Parameters:

value - string to be checked

trim - whether the string must be trimmed prior checking or not

customMessage - custom message to be put into the exception

params - parameters to be applied to the custom message

Returns:

checked string

See Also:

String.format(String, Object...)

isA

public static <T,K> T isA(T value,
                          java.lang.Class<K> clazz,
                          java.lang.String paramName)

Checks that value is of type K. If it is not, an IllegalArgumentException is thrown with an appropriate message.

Type Parameters:

T - current value type

K - expected value type

Parameters:

value - current value

clazz - expected class

paramName - name of the parameter to be used inside the message put into the exception

Returns:

current value

isA

public static <T,K> T isA(T value,
                          java.lang.Class<K> clazz,
                          java.lang.String customMessage,
                          java.lang.Object... params)

Checks that value is of type K. If it is not, an IllegalArgumentException is thrown with an appropriate message.

Type Parameters:

T - current value type

K - expected value type

Parameters:

value - current value

clazz - expected class

customMessage - Custom message to be put inside the IllegalArgumentException

params - parameters to be applied to customMessage (String.format(String, Object...))

Returns:

current value