@Internal public class Preconditions extends java.lang.Object
Preconditions
that throws more
appropriate exception classes while being static analysis friendly.Constructor and Description |
---|
Preconditions() |
Modifier and Type | Method and Description |
---|---|
static <T> T |
checkArgumentNotNull(T reference)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T reference,
@Nullable java.lang.Object errorMessage)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
char p1)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
char p1,
char p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
char p1,
int p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
char p1,
long p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
char p1,
@Nullable java.lang.Object p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
int p1)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
int p1,
char p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
int p1,
int p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
int p1,
long p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
int p1,
@Nullable java.lang.Object p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
long p1)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
long p1,
char p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
long p1,
int p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
long p1,
long p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
long p1,
@Nullable java.lang.Object p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T reference,
@Nullable 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> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1,
char p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1,
int p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1,
long p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1,
@Nullable java.lang.Object p2)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1,
@Nullable java.lang.Object p2,
@Nullable java.lang.Object p3)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
static <T> T |
checkArgumentNotNull(T obj,
@Nullable java.lang.String errorMessageTemplate,
@Nullable java.lang.Object p1,
@Nullable java.lang.Object p2,
@Nullable java.lang.Object p3,
@Nullable java.lang.Object p4)
Ensures that an object reference passed as a parameter to the calling method is not null.
|
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T reference)
reference
- an object referencejava.lang.IllegalArgumentException
- if reference
is null@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T reference, @Nullable java.lang.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)
java.lang.IllegalArgumentException
- if reference
is null@CanIgnoreReturnValue @EnsuresNonNull(value="reference") public static <T> T checkArgumentNotNull(T reference, @Nullable java.lang.String errorMessageTemplate, java.lang.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)
.java.lang.IllegalArgumentException
- if reference
is null@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, char p1)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, int p1)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, long p1)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, char p1, char p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, char p1, int p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, char p1, long p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, char p1, @Nullable java.lang.Object p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, int p1, char p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, int p1, int p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, int p1, long p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, int p1, @Nullable java.lang.Object p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, long p1, char p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, long p1, int p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, long p1, long p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, long p1, @Nullable java.lang.Object p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1, char p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1, int p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1, long p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1, @Nullable java.lang.Object p2)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1, @Nullable java.lang.Object p2, @Nullable java.lang.Object p3)
See checkArgumentNotNull(Object, String, Object...)
for details.
@CanIgnoreReturnValue @EnsuresNonNull(value="#1") public static <T> T checkArgumentNotNull(T obj, @Nullable java.lang.String errorMessageTemplate, @Nullable java.lang.Object p1, @Nullable java.lang.Object p2, @Nullable java.lang.Object p3, @Nullable java.lang.Object p4)
See checkArgumentNotNull(Object, String, Object...)
for details.