greyfox.rxnetwork.common.base

Class Preconditions

java.lang.Object

greyfox.rxnetwork.common.base.Preconditions

public final class Preconditions
extends java.lang.Object

Static convenience methods that help a method or constructor check whether it was invoked correctly (whether its preconditions have been met). In the case of checkNotNullWithMessage, an object reference which is expected to be non-null). When false (or null) is passed instead, the Preconditions method throws an unchecked exception, which helps the calling method communicate to its caller that that caller has made a mistake.

Method Summary

Modifier and Type	Method and Description
static <T> T	checkNotNull(T reference) Ensures that an object reference passed as a parameter to the calling method is not null.
static <T> T	checkNotNull(T reference, java.lang.String name) Ensures that an object reference passed as a parameter to the calling method is not null.
static <T> T	checkNotNullWithMessage(T reference, java.lang.String message) Ensures that an object reference passed as a parameter to the calling method is not null.
static <T> T	checkNotNullWithMessage(T reference, java.lang.String messageFormat, java.lang.Object... args) Ensures that an object reference passed as a parameter to the calling method is not null.

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 reference)

Ensures that an object reference passed as a parameter to the calling method is not null.

Parameters:

reference - an object reference

Returns:

the non-null reference that was validated

Throws:

java.lang.NullPointerException - if reference is null

checkNotNull

public static <T> T checkNotNull(T reference,
                                 java.lang.String name)

Ensures that an object reference passed as a parameter to the calling method is not null.

Parameters:

reference - an object reference

name - an object reference name

Returns:

the non-null reference that was validated

Throws:

java.lang.NullPointerException - if reference is null

checkNotNullWithMessage

public static <T> T checkNotNullWithMessage(T reference,
                                            java.lang.String message)

Ensures that an object reference passed as a parameter to the calling method is not null.

Parameters:

reference - an object reference

message - exception message should the check fail

Returns:

the non-null reference that was validated

Throws:

java.lang.NullPointerException - if reference is null

checkNotNullWithMessage

public static <T> T checkNotNullWithMessage(T reference,
                                            java.lang.String messageFormat,
                                            java.lang.Object... args)

Ensures that an object reference passed as a parameter to the calling method is not null.

Parameters:

reference - an object reference

messageFormat - exception message as described in format string

args - arguments referenced by the messageFormat specifiers

Returns:

the non-null reference that was validated

Throws:

java.lang.NullPointerException - if reference is null