com.palantir.logsafe

Class Preconditions

java.lang.Object

com.palantir.logsafe.Preconditions

public final class Preconditions
extends java.lang.Object

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.String message) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, java.lang.String message, com.palantir.logsafe.Arg<?>... args) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, java.lang.String message, com.palantir.logsafe.Arg<?> arg) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, java.lang.String message, com.palantir.logsafe.Arg<?> arg1, com.palantir.logsafe.Arg<?> arg2) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, java.lang.String message, com.palantir.logsafe.Arg<?> arg1, com.palantir.logsafe.Arg<?> arg2, com.palantir.logsafe.Arg<?> arg3) Ensures the truth of an expression involving one or more parameters to the calling method.
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 message) 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 message, com.palantir.logsafe.Arg<?>... args) 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 message, com.palantir.logsafe.Arg<?> arg) 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 message, com.palantir.logsafe.Arg<?> arg1, com.palantir.logsafe.Arg<?> arg2) 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 message, com.palantir.logsafe.Arg<?> arg1, com.palantir.logsafe.Arg<?> arg2, com.palantir.logsafe.Arg<?> arg3) Ensures that an Object reference passed as a parameter to the calling method is not null.
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 void	checkState(boolean expression, java.lang.String message) 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 message, com.palantir.logsafe.Arg<?>... args) 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 message, com.palantir.logsafe.Arg<?> arg) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkState(boolean expression, java.lang.String message, com.palantir.logsafe.Arg<?> arg1, com.palantir.logsafe.Arg<?> arg2) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkState(boolean expression, java.lang.String message, com.palantir.logsafe.Arg<?> arg1, com.palantir.logsafe.Arg<?> arg2, com.palantir.logsafe.Arg<?> arg3) Ensures the truth of an expression involving one or more 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 - a boolean expression

Throws:

SafeIllegalArgumentException - if expression is false

checkArgument

public static void checkArgument(boolean expression,
                                 @CompileTimeConstant
                                 java.lang.String message)

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

Parameters:

expression - a boolean expression

message - the loggable exception message

Throws:

SafeIllegalArgumentException - if expression is false

checkArgument

public static void checkArgument(boolean expression,
                                 @CompileTimeConstant
                                 java.lang.String message,
                                 com.palantir.logsafe.Arg<?> arg)

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

See checkArgument(boolean, String, Arg...) for details.

checkArgument

public static void checkArgument(boolean expression,
                                 @CompileTimeConstant
                                 java.lang.String message,
                                 com.palantir.logsafe.Arg<?> arg1,
                                 com.palantir.logsafe.Arg<?> arg2)

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

See checkArgument(boolean, String, Arg...) for details.

checkArgument

public static void checkArgument(boolean expression,
                                 @CompileTimeConstant
                                 java.lang.String message,
                                 com.palantir.logsafe.Arg<?> arg1,
                                 com.palantir.logsafe.Arg<?> arg2,
                                 com.palantir.logsafe.Arg<?> arg3)

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

See checkArgument(boolean, String, Arg...) for details.

checkArgument

public static void checkArgument(boolean expression,
                                 @CompileTimeConstant
                                 java.lang.String message,
                                 com.palantir.logsafe.Arg<?>... args)

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

Parameters:

expression - a boolean expression

message - the loggable exception message

args - the arguments to include in the SafeIllegalArgumentException

Throws:

SafeIllegalArgumentException - if expression is false

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 - a boolean expression

Throws:

SafeIllegalStateException - if expression is false

checkState

public static void checkState(boolean expression,
                              @CompileTimeConstant
                              java.lang.String message)

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

Parameters:

expression - a boolean expression

message - the loggable exception message

Throws:

SafeIllegalStateException - if expression is false

checkState

public static void checkState(boolean expression,
                              @CompileTimeConstant
                              java.lang.String message,
                              com.palantir.logsafe.Arg<?> arg)

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

See checkState(boolean, String, Arg...) for details.

checkState

public static void checkState(boolean expression,
                              @CompileTimeConstant
                              java.lang.String message,
                              com.palantir.logsafe.Arg<?> arg1,
                              com.palantir.logsafe.Arg<?> arg2)

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

See checkState(boolean, String, Arg...) for details.

checkState

public static void checkState(boolean expression,
                              @CompileTimeConstant
                              java.lang.String message,
                              com.palantir.logsafe.Arg<?> arg1,
                              com.palantir.logsafe.Arg<?> arg2,
                              com.palantir.logsafe.Arg<?> arg3)

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

See checkState(boolean, String, Arg...) for details.

checkState

public static void checkState(boolean expression,
                              @CompileTimeConstant
                              java.lang.String message,
                              com.palantir.logsafe.Arg<?>... args)

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

Parameters:

expression - a boolean expression

message - the loggable exception message

args - the arguments to include in the SafeIllegalStateException

Throws:

SafeIllegalStateException - if expression is false

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(@Nullable
                                                       T reference)

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

Parameters:

reference - an String reference

Returns:

the non-null reference that was validated

Throws:

SafeNullPointerException - if reference is null

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(@Nullable
                                                       T reference,
                                                       @CompileTimeConstant
                                                       java.lang.String message)

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

Parameters:

reference - an String reference

message - the loggable exception message

Returns:

the non-null reference that was validated

Throws:

SafeNullPointerException - if reference is null

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(@Nullable
                                                       T reference,
                                                       @CompileTimeConstant
                                                       java.lang.String message,
                                                       com.palantir.logsafe.Arg<?> arg)

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

See checkNotNull(Object, String, Arg...) for details.

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(@Nullable
                                                       T reference,
                                                       @CompileTimeConstant
                                                       java.lang.String message,
                                                       com.palantir.logsafe.Arg<?> arg1,
                                                       com.palantir.logsafe.Arg<?> arg2)

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

See checkNotNull(Object, String, Arg...) for details.

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(@Nullable
                                                       T reference,
                                                       @CompileTimeConstant
                                                       java.lang.String message,
                                                       com.palantir.logsafe.Arg<?> arg1,
                                                       com.palantir.logsafe.Arg<?> arg2,
                                                       com.palantir.logsafe.Arg<?> arg3)

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

See checkNotNull(Object, String, Arg...) for details.

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(@Nullable
                                                       T reference,
                                                       @CompileTimeConstant
                                                       java.lang.String message,
                                                       com.palantir.logsafe.Arg<?>... args)

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

Parameters:

reference - an String reference

message - the loggable exception message

args - the arguments to include in the SafeNullPointerException

Returns:

the non-null reference that was validated

Throws:

SafeNullPointerException - if reference is null