public final class Preconditions extends Object
NOTE: proxy for the Guava implementation of Preconditions
.
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,
Object errorMessage)
Ensures the truth of an expression involving one or more parameters to the calling method.
|
static void |
checkArgument(boolean expression,
String errorMessageTemplate,
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,
Object errorMessage)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkNotNull(T reference,
String errorMessageTemplate,
Object... errorMessageArgs)
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,
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,
String errorMessageTemplate,
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 void checkArgument(boolean expression)
expression
- a boolean expressionIllegalArgumentException
- if expression
is falsepublic static void checkArgument(boolean expression, 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)
IllegalArgumentException
- if expression
is falsepublic static void checkArgument(boolean expression, String errorMessageTemplate, 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)
.IllegalArgumentException
- if expression
is falseNullPointerException
- if the check fails and either errorMessageTemplate
or
errorMessageArgs
is null (don't let this happen)public static void checkState(boolean expression)
expression
- a boolean expressionIllegalStateException
- if expression
is falsepublic static void checkState(boolean expression, 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)
IllegalStateException
- if expression
is falsepublic static void checkState(boolean expression, String errorMessageTemplate, 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)
.IllegalStateException
- if expression
is falseNullPointerException
- if the check fails and either errorMessageTemplate
or
errorMessageArgs
is null (don't let this happen)public static <T> T checkNotNull(T reference)
reference
- an object referenceNullPointerException
- if reference
is nullpublic static <T> T checkNotNull(T reference, Object errorMessage)
reference
- an object referenceerrorMessage
- the exception message to use if the check fails; will be converted to a
string using String.valueOf(Object)
NullPointerException
- if reference
is nullpublic static <T> T checkNotNull(T reference, String errorMessageTemplate, Object... errorMessageArgs)
reference
- an object referenceerrorMessageTemplate
- 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)
.NullPointerException
- if reference
is nullCopyright © 2011–2022 Google. All rights reserved.