cn.jdevelops.api.result.util

类 Assert

java.lang.Object

cn.jdevelops.api.result.util.Assert

public abstract class Assert
extends Object

Assertion utility class that assists in validating arguments.

Useful for identifying programmer errors early and clearly at runtime.

For example, if the contract of a public method states it does not allow null arguments, Assert can be used to validate that contract. Doing this clearly indicates a contract violation when it occurs and protects the class's invariants.

Typically used to validate method arguments rather than configuration properties, to check for cases that are usually programmer errors rather than configuration errors. In contrast to configuration initialization code, there is usually no point in falling back to defaults in such methods.

This class is similar to JUnit's assertion library. If an argument value is deemed invalid, an IllegalArgumentException is thrown (typically). For example:

 Assert.notNull(clazz, "The class must not be null");
 Assert.isTrue(i > 0, "The value must be greater than zero");

Mainly for internal use within the framework; for a more comprehensive suite of assertion utilities consider org.apache.commons.lang3.Validate from Apache Commons Lang, Google Guava's Preconditions, or similar third-party libraries.

从以下版本开始:

1.1.2

作者

Keith Donald, Juergen Hoeller, Sam Brannen, Colin Sampaleanu, Rob Harrop

方法概要

限定符和类型	方法和说明
static void	isNull(Object object) 已过时。 as of 4.3.7, in favor of isNull(Object, String)
static void	isNull(Object object, String message) Assert that an object is null.
static void	isNull(Object object, Supplier<String> messageSupplier) Assert that an object is null.
static void	isTrue(boolean expression) 已过时。 as of 4.3.7, in favor of isTrue(boolean, String)
static void	isTrue(boolean expression, String message) Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.
static void	isTrue(boolean expression, Supplier<String> messageSupplier) Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.
static void	notEmpty(Object[] array, String message) Assert that an array contains elements; that is, it must not be null and must contain at least one element.
static void	notNull(Object object) 已过时。 as of 4.3.7, in favor of notNull(Object, String)
static void	notNull(Object object, String message) Assert that an object is not null.
static void	notNull(Object object, Supplier<String> messageSupplier) Assert that an object is not null.

从类继承的方法 java.lang.Object

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

方法详细资料

isTrue

public static void isTrue(boolean expression,
                          String message)

Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

Assert.isTrue(i > 0, "The value must be greater than zero");

抛出:

IllegalArgumentException - if expression is false

参数

a boolean expression, the exception message to use if the assertion fails

isTrue

public static void isTrue(boolean expression,
                          Supplier<String> messageSupplier)

Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

 Assert.isTrue(i > 0, () -> "The value '" + i + "' must be greater than zero");
 

抛出:

IllegalArgumentException - if expression is false

从以下版本开始:

5.0

参数

a boolean expression, a supplier for the exception message to use if the assertion fails

isTrue

@Deprecated
public static void isTrue(boolean expression)

已过时。 as of 4.3.7, in favor of isTrue(boolean, String)

Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

isNull

public static void isNull(Object object,
                          String message)

Assert that an object is null.

Assert.isNull(value, "The value must be null");

抛出:

IllegalArgumentException - if the object is not null

参数

the object to check, the exception message to use if the assertion fails

isNull

public static void isNull(Object object,
                          Supplier<String> messageSupplier)

Assert that an object is null.

 Assert.isNull(value, () -> "The value '" + value + "' must be null");
 

抛出:

IllegalArgumentException - if the object is not null

从以下版本开始:

5.0

参数

the object to check, a supplier for the exception message to use if the assertion fails

isNull

@Deprecated
public static void isNull(Object object)

已过时。 as of 4.3.7, in favor of isNull(Object, String)

Assert that an object is null.

notNull

public static void notNull(Object object,
                           String message)

Assert that an object is not null.

Assert.notNull(clazz, "The class must not be null");

抛出:

IllegalArgumentException - if the object is null

参数

the object to check, the exception message to use if the assertion fails

notNull

public static void notNull(Object object,
                           Supplier<String> messageSupplier)

Assert that an object is not null.

 Assert.notNull(entity.getId(),
     () -> "ID for entity " + entity.getName() + " must not be null");
 

抛出:

IllegalArgumentException - if the object is null

从以下版本开始:

5.0

参数

the object to check, a supplier for the exception message to use if the assertion fails

notNull

@Deprecated
public static void notNull(Object object)

已过时。 as of 4.3.7, in favor of notNull(Object, String)

Assert that an object is not null.

notEmpty

public static void notEmpty(Object[] array,
                            String message)

Assert that an array contains elements; that is, it must not be null and must contain at least one element.

Assert.notEmpty(array, "The array must contain elements");

抛出:

IllegalArgumentException - if the object array is null or contains no elements

参数

the array to check, the exception message to use if the assertion fails