io.orchestrate.client

Class Preconditions

java.lang.Object

io.orchestrate.client.Preconditions

public final class Preconditions
extends java.lang.Object

A helper class to handle precondition checking in method calls.

Constructor Summary

Constructors

Constructor and Description
Preconditions()

Method Summary

Modifier and Type	Method and Description
static void	checkArgument(boolean condition, java.lang.String errorMsg) Checks that the condition is true.
static java.lang.String[]	checkNoneEmpty(java.lang.String[] values, java.lang.String paramName, java.lang.String itemName) Checks that the values are not empty.
static int	checkNotNegative(int value, java.lang.String paramName) Checks that the value is not negative.
static long	checkNotNegative(long value, java.lang.String paramName) Checks that the value is not negative.
static <T> T	checkNotNull(T value, java.lang.String paramName) Checks that the value is not null.
static java.lang.String	checkNotNullOrEmpty(java.lang.String value, java.lang.String paramName) Checks that the value is not empty.

Methods inherited from class java.lang.Object

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

Constructor Detail

Preconditions

public Preconditions()

Method Detail

checkNotNull

public static <T> T checkNotNull(T value,
                                 java.lang.String paramName)

Checks that the value is not null. Returns the value directly, so you can use checkNotNull(value) inline.

Type Parameters:

T - The type of the value being checked.

Parameters:

value - The object to perform the null check.

paramName - The name of the parameter that cannot be null.

Returns:

The value that was checked.

checkNotNullOrEmpty

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

Checks that the value is not empty.

Parameters:

value - The object to perform the check on.

paramName - The name of the parameter that can't be empty.

Returns:

The value that was checked.

checkArgument

public static void checkArgument(boolean condition,
                                 java.lang.String errorMsg)

Checks that the condition is true. Use for validating arguments to methods.

Parameters:

condition - The condition to check.

errorMsg - The error message to display if the check was false.

checkNotNegative

public static int checkNotNegative(int value,
                                   java.lang.String paramName)

Checks that the value is not negative.

Parameters:

value - The object to perform the check on.

paramName - The name of the parameter that can't be negative.

Returns:

The value that was checked.

checkNotNegative

public static long checkNotNegative(long value,
                                    java.lang.String paramName)

Checks that the value is not negative.

Parameters:

value - The object to perform the check on.

paramName - The name of the parameter that can't be negative.

Returns:

The value that was checked.

checkNoneEmpty

public static java.lang.String[] checkNoneEmpty(java.lang.String[] values,
                                                java.lang.String paramName,
                                                java.lang.String itemName)

Checks that the values are not empty.

Parameters:

values - The values to check.

paramName - The name of the parameter that is to be checked.

itemName - The name of an item from the values.

Returns:

The value that was checked.