com.kontakt.sdk.android.common.util

Class SDKPreconditions

java.lang.Object

com.kontakt.sdk.android.common.util.SDKPreconditions

public final class SDKPreconditions
extends java.lang.Object

Preconditions provide utility validation methods. For more information

See Also:

Guava Libraries project.

Method Summary

Modifier and Type	Method and Description
static void	checkAllowedSize(java.util.Collection<?> collection, int allowedSize, java.lang.String message)
static void	checkArgument(boolean expression) Ensures the truth of an expression involving one or more parameters to the calling method.
static <E extends java.lang.Exception> void	checkArgument(boolean expression, E exception) 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 errorMessageTemplate, java.lang.Object... errorMessageArgs) Ensures the truth of an expression involving one or more parameters to the calling method.
static int	checkElementIndex(int index, int size) Ensures that index specifies a valid element in an array, list or string of size size.
static int	checkElementIndex(int index, int size, java.lang.String desc) Ensures that index specifies a valid element in an array, list or string of size size.
static <T,K extends java.lang.RuntimeException> T[]	checkNotAllNull(K exception, T... references)
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 <T> T	checkNotNull(T reference, java.lang.String errorMessageTemplate, java.lang.Object... errorMessageArgs) Ensures that an object reference passed as a parameter to the calling method is not null.
static <T> void	checkNotNullOrEmpty(java.util.Collection<T> collection, java.lang.String message) Ensures that collection is not null or empty.
static void	checkNotNullOrEmpty(java.lang.String target, java.lang.String message) Ensures that String is not null or empty.
static int	checkPositionIndex(int index, int size) Ensures that index specifies a valid position in an array, list or string of size size.
static int	checkPositionIndex(int index, int size, java.lang.String desc) Ensures that index specifies a valid position in an array, list or string of size size.
static void	checkPositionIndexes(int start, int end, int size) Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order.
static void	checkState(boolean expression) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
static <E extends java.lang.Exception> void	checkState(boolean expression, E exception) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
static void	checkState(boolean expression, java.lang.Object errorMessage) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
static void	checkState(boolean expression, java.lang.String errorMessageTemplate, java.lang.Object... errorMessageArgs) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Methods inherited from class java.lang.Object

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

Method Detail

checkArgument

public static void checkArgument(boolean expression)

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

Parameters:

expression - the expression

checkArgument

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

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

Parameters:

expression - the expression

errorMessage - the error message

checkArgument

public static <E extends java.lang.Exception> void checkArgument(boolean expression,
                                                                 E exception)
                                                          throws E extends java.lang.Exception

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

Type Parameters:

E - the type parameter

Parameters:

expression - the expression

exception - the exception

Throws:

E - the e

E extends java.lang.Exception

checkArgument

public static void checkArgument(boolean expression,
                                 java.lang.String errorMessageTemplate,
                                 java.lang.Object... errorMessageArgs)

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

Parameters:

expression - the expression

errorMessageTemplate - the error message template

errorMessageArgs - the error message args

checkState

public static void checkState(boolean expression)

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Parameters:

expression - the expression

checkState

public static <E extends java.lang.Exception> void checkState(boolean expression,
                                                              E exception)
                                                       throws E extends java.lang.Exception

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Type Parameters:

E - the type parameter

Parameters:

expression - the expression

exception - the exception

Throws:

E - the e

E extends java.lang.Exception

checkState

public static void checkState(boolean expression,
                              java.lang.Object errorMessage)

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Parameters:

expression - the expression

errorMessage - the error message

checkState

public static void checkState(boolean expression,
                              java.lang.String errorMessageTemplate,
                              java.lang.Object... errorMessageArgs)

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Parameters:

expression - the expression

errorMessageTemplate - the error message template

errorMessageArgs - the error message args

checkNotNull

public static <T> T checkNotNull(T reference)

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

Type Parameters:

T - the type parameter

Parameters:

reference - the reference

Returns:

the t

checkNotNull

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

Type Parameters:

T - the type parameter

Parameters:

reference - the reference

errorMessage - the error message

Returns:

the t

checkNotNull

public static <T> T checkNotNull(T reference,
                                 java.lang.String errorMessageTemplate,
                                 java.lang.Object... errorMessageArgs)

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

Type Parameters:

T - the type parameter

Parameters:

reference - the reference

errorMessageTemplate - the error message template

errorMessageArgs - the error message args

Returns:

the t

checkNotAllNull

public static <T,K extends java.lang.RuntimeException> T[] checkNotAllNull(K exception,
                                                                           T... references)

checkNotNullOrEmpty

public static <T> void checkNotNullOrEmpty(java.util.Collection<T> collection,
                                           java.lang.String message)

Ensures that collection is not null or empty.

Type Parameters:

T - the type parameter

Parameters:

collection - the collection

message - the message

checkNotNullOrEmpty

public static void checkNotNullOrEmpty(java.lang.String target,
                                       java.lang.String message)

Ensures that String is not null or empty.

Parameters:

target - the target

message - the message

checkElementIndex

public static int checkElementIndex(int index,
                                    int size)

Ensures that index specifies a valid element in an array, list or string of size size.

Parameters:

index - the index

size - the size

Returns:

the int

checkElementIndex

public static int checkElementIndex(int index,
                                    int size,
                                    java.lang.String desc)

Ensures that index specifies a valid element in an array, list or string of size size.

Parameters:

index - the index

size - the size

desc - the desc

Returns:

the int

checkPositionIndex

public static int checkPositionIndex(int index,
                                     int size)

Ensures that index specifies a valid position in an array, list or string of size size.

Parameters:

index - the index

size - the size

Returns:

the int

checkPositionIndex

public static int checkPositionIndex(int index,
                                     int size,
                                     java.lang.String desc)

Ensures that index specifies a valid position in an array, list or string of size size.

Parameters:

index - the index

size - the size

desc - the desc

Returns:

the int

checkPositionIndexes

public static void checkPositionIndexes(int start,
                                        int end,
                                        int size)

Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order.

Parameters:

start - the start

end - the end

size - the size

checkAllowedSize

public static void checkAllowedSize(java.util.Collection<?> collection,
                                    int allowedSize,
                                    java.lang.String message)