public final class Preconditions
extends java.lang.Object
com.google.common.base.Preconditions that is specially tailored
to support checks applied in Dagger's generated code.| Modifier and Type | Method and Description |
|---|---|
static void |
checkArgument(boolean expression) |
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 <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 errorMessage)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static void |
checkState(boolean expression) |
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.
|
public static <T> T checkNotNull(T reference)
reference - an object referencejava.lang.NullPointerException - if reference is nullpublic static <T> T checkNotNull(T reference,
java.lang.String errorMessage)
reference - an object referenceerrorMessage - the exception message to use if the check failsjava.lang.NullPointerException - if reference is nullpublic static void checkArgument(boolean expression)
public static void checkArgument(boolean expression,
java.lang.Object errorMessage)
expression - a boolean expressionerrorMessage - the exception message to use if the check fails; will be converted to a
string using String.valueOf(Object)java.lang.IllegalArgumentException - if expression is falsepublic static void checkArgument(boolean expression,
java.lang.String errorMessageTemplate,
java.lang.Object... errorMessageArgs)
expression - a boolean expressionerrorMessageTemplate - a template for the exception message should the check fail. The
message is formed by replacing each %s placeholder in the template with an
argument. These are matched by position - the first %s gets errorMessageArgs[0], etc. Unmatched arguments will be appended to the formatted message
in square braces. Unmatched placeholders will be left as-is.errorMessageArgs - the arguments to be substituted into the message template. Arguments
are converted to strings using String.valueOf(Object).java.lang.IllegalArgumentException - if expression is falsejava.lang.NullPointerException - if the check fails and either errorMessageTemplate or
errorMessageArgs is null (don't let this happen)public static void checkState(boolean expression)
public static void checkState(boolean expression,
java.lang.Object errorMessage)
expression - a boolean expressionerrorMessage - the exception message to use if the check fails; will be converted to a
string using String.valueOf(Object)java.lang.IllegalStateException - if expression is falsepublic static void checkState(boolean expression,
java.lang.String errorMessageTemplate,
java.lang.Object... errorMessageArgs)
expression - a boolean expressionerrorMessageTemplate - a template for the exception message should the check fail. The
message is formed by replacing each %s placeholder in the template with an
argument. These are matched by position - the first %s gets errorMessageArgs[0], etc. Unmatched arguments will be appended to the formatted message
in square braces. Unmatched placeholders will be left as-is.errorMessageArgs - the arguments to be substituted into the message template. Arguments
are converted to strings using String.valueOf(Object).java.lang.IllegalStateException - if expression is falsejava.lang.NullPointerException - if the check fails and either errorMessageTemplate or
errorMessageArgs is null (don't let this happen)