net.openid.appauth

Class Preconditions

java.lang.Object

net.openid.appauth.Preconditions

public final class Preconditions
extends java.lang.Object

Utility class for guava style pre-condition checks. Not an official part of the AppAuth API; only intended for internal use and no guarantees are given on source or binary compatibility for this class between versions of AppAuth.

Method Summary

Modifier and Type	Method and Description
static void	checkArgument(boolean expression) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, java.lang.Object errorMessage) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, java.lang.String errorTemplate, java.lang.Object... params) Ensures the truth of an expression involving one or more parameters to the calling method.
static <T extends java.util.Collection<?>> T	checkCollectionNotEmpty(T collection, java.lang.Object errorMessage) Ensures that a collection is not null or empty.
static java.lang.String	checkNotEmpty(java.lang.String str, java.lang.Object errorMessage) Ensures that a string is not null or empty.
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.Object errorMessage) Ensures that an object reference passed as a parameter to the calling method is not null.
static java.lang.String	checkNullOrNotEmpty(java.lang.String str, java.lang.Object errorMessage) Ensures that the string is either null, or a non-empty string.

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,
                                 @Nullable
                                 java.lang.Object errorMessage)

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

Parameters:

reference - an object reference

errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)

Returns:

the non-null reference that was validated

Throws:

java.lang.NullPointerException - if reference is null

checkNotEmpty

@NonNull
public static java.lang.String checkNotEmpty(java.lang.String str,
                                                      @Nullable
                                                      java.lang.Object errorMessage)

Ensures that a string is not null or empty.

checkCollectionNotEmpty

@NonNull
public static <T extends java.util.Collection<?>> T checkCollectionNotEmpty(T collection,
                                                                                     @Nullable
                                                                                     java.lang.Object errorMessage)

Ensures that a collection is not null or empty.

checkNullOrNotEmpty

@NonNull
public static java.lang.String checkNullOrNotEmpty(java.lang.String str,
                                                            @Nullable
                                                            java.lang.Object errorMessage)

Ensures that the string is either null, or a non-empty string.

checkArgument

public static void checkArgument(boolean expression)

Ensures the truth of an expression involving one or more parameters to the calling method.

Parameters:

expression - a boolean expression

Throws:

java.lang.IllegalArgumentException - if expression is false

checkArgument

public static void checkArgument(boolean expression,
                                 @Nullable
                                 java.lang.Object errorMessage)

Ensures the truth of an expression involving one or more parameters to the calling method.

Parameters:

expression - a boolean expression

errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)

Throws:

java.lang.IllegalArgumentException - if expression is false

checkArgument

public static void checkArgument(boolean expression,
                                 @NonNull
                                 java.lang.String errorTemplate,
                                 java.lang.Object... params)

Ensures the truth of an expression involving one or more parameters to the calling method.

Parameters:

expression - a boolean expression

errorTemplate - the exception message to use if the check fails; this is used as the template for String.format.

params - the parameters to the exception message.