net.gdface.utils

类 ConditionChecks

java.lang.Object

net.gdface.utils.ConditionChecks

public class ConditionChecks
extends java.lang.Object

条件检查工具类

作者:

guyadong

方法概要

限定符和类型	方法和说明
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 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,X extends java.lang.Throwable> T	checkNotNull(T reference, java.lang.Class<X> declareType, java.lang.Object ctorArg) reference为null时抛出 declareType 异常
static <T,X extends java.lang.Throwable> T	checkNotNull(T reference, java.lang.Class<X> declareType, java.lang.Object ctorArg, java.lang.String errorMessageTemplate, java.lang.Object... errorMessageArgs) reference为null时抛出 declareType 异常
static <T,X extends java.lang.Throwable> T	checkNotNull(T reference, java.lang.Class<X> declareType, java.lang.Object ctorArg, java.lang.String errorMessageTemplate, java.lang.Object p1) reference为null时抛出 declareType 异常 SeecheckNotNull(Object, Class, Object, String, Object[]) for details.
static <T,X extends java.lang.Throwable> T	checkNotNull(T reference, java.lang.Class<X> declareType, java.lang.String errorMessageTemplate, java.lang.Object... errorMessageArgs) reference为null时抛出 declareType 异常
static <T,X extends java.lang.Throwable> T	checkNotNull(T reference, java.lang.Class<X> declareType, java.lang.String errorMessageTemplate, java.lang.Object p1) reference为null时抛出 declareType 异常 SeecheckNotNull(Object, Class, String, Object[]) for details.
static <T> T	checkNotNull(T reference, 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 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 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.
static <X extends java.lang.Throwable> void	checkTrue(boolean b, java.lang.Class<X> declareType, java.lang.Object ctorArg) 执行表达式,为false时抛出 declareType 异常
static <X extends java.lang.Throwable> void	checkTrue(boolean b, java.lang.Class<X> declareType, java.lang.Object ctorArg, java.lang.String errorMessageTemplate, java.lang.Object... errorMessageArgs) 执行表达式,为false时抛出 declareType 异常
static <X extends java.lang.Throwable> void	checkTrue(boolean b, java.lang.Class<X> declareType, java.lang.Object ctorArg, java.lang.String errorMessageTemplate, java.lang.Object p1) 执行表达式,为false时抛出 declareType 异常 See checkTrue(boolean, Class,Object, String, Object...) for details.
static <X extends java.lang.Throwable> void	checkTrue(boolean b, java.lang.Class<X> declareType, java.lang.String errorMessageTemplate, java.lang.Object... errorMessageArgs) 执行表达式,为false时抛出 declareType 异常
static <X extends java.lang.Throwable> void	checkTrue(boolean b, java.lang.Class<X> declareType, java.lang.String errorMessageTemplate, java.lang.Object p1) 执行表达式,为false时抛出 declareType 异常 See checkTrue(boolean, Class, String, Object...) for details.
static java.lang.String	format(java.lang.String template, java.lang.Object... args) Substitutes each %s in template with an argument.

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

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

方法详细资料

checkTrue

public static <X extends java.lang.Throwable> void checkTrue(boolean b,
                                                             java.lang.Class<X> declareType,
                                                             @Nullable
                                                             java.lang.String errorMessageTemplate,
                                                             @Nullable
                                                             java.lang.Object... errorMessageArgs)
                                                      throws X extends java.lang.Throwable

执行表达式,为false时抛出 declareType 异常

类型参数:

X - 抛出异常类型

参数:

b -

declareType - 异常类型

errorMessageTemplate - 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).

抛出:

X

X extends java.lang.Throwable

checkTrue

public static <X extends java.lang.Throwable> void checkTrue(boolean b,
                                                             java.lang.Class<X> declareType,
                                                             @Nullable
                                                             java.lang.String errorMessageTemplate,
                                                             @Nullable
                                                             java.lang.Object p1)
                                                      throws X extends java.lang.Throwable

执行表达式,为false时抛出 declareType 异常

See checkTrue(boolean, Class, String, Object...) for details.

抛出:

X

X extends java.lang.Throwable

checkTrue

public static <X extends java.lang.Throwable> void checkTrue(boolean b,
                                                             java.lang.Class<X> declareType,
                                                             java.lang.Object ctorArg,
                                                             @Nullable
                                                             java.lang.String errorMessageTemplate,
                                                             @Nullable
                                                             java.lang.Object... errorMessageArgs)
                                                      throws X extends java.lang.Throwable

执行表达式,为false时抛出 declareType 异常

类型参数:

X - 抛出异常类型

参数:

b -

declareType - 异常类型,要求有两个参数的构造方法(ctorArg,String)或(String,ctorArg)

ctorArg - 异常类型构造方法的第一或第二个参数,另一个参数类型为String

errorMessageTemplate - 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).

抛出:

X

X extends java.lang.Throwable

checkTrue

public static <X extends java.lang.Throwable> void checkTrue(boolean b,
                                                             java.lang.Class<X> declareType,
                                                             java.lang.Object ctorArg,
                                                             @Nullable
                                                             java.lang.String errorMessageTemplate,
                                                             @Nullable
                                                             java.lang.Object p1)
                                                      throws X extends java.lang.Throwable

执行表达式,为false时抛出 declareType 异常

See checkTrue(boolean, Class,Object, String, Object...) for details.

抛出:

X

X extends java.lang.Throwable

checkTrue

public static <X extends java.lang.Throwable> void checkTrue(boolean b,
                                                             java.lang.Class<X> declareType,
                                                             java.lang.Object ctorArg)
                                                      throws X extends java.lang.Throwable

执行表达式,为false时抛出 declareType 异常

类型参数:

X - 抛出异常类型

参数:

b -

declareType - 异常类型

ctorArg - 异常类型构造方法的参数

抛出:

X

X extends java.lang.Throwable

checkNotNull

public static <T,X extends java.lang.Throwable> T checkNotNull(T reference,
                                                               java.lang.Class<X> declareType,
                                                               @Nullable
                                                               java.lang.String errorMessageTemplate,
                                                               @Nullable
                                                               java.lang.Object... errorMessageArgs)
                                                        throws X extends java.lang.Throwable

reference为null时抛出 declareType 异常

类型参数:

T - 对象类型

X - 抛出异常类型

参数:

reference -

declareType - 异常类型

errorMessageTemplate - 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).

返回:

always reference

抛出:

X

X extends java.lang.Throwable

checkNotNull

public static <T,X extends java.lang.Throwable> T checkNotNull(T reference,
                                                               java.lang.Class<X> declareType,
                                                               @Nullable
                                                               java.lang.String errorMessageTemplate,
                                                               @Nullable
                                                               java.lang.Object p1)
                                                        throws X extends java.lang.Throwable

reference为null时抛出 declareType 异常

SeecheckNotNull(Object, Class, String, Object[]) for details.

返回:

always reference

抛出:

X

X extends java.lang.Throwable

checkNotNull

public static <T,X extends java.lang.Throwable> T checkNotNull(T reference,
                                                               java.lang.Class<X> declareType,
                                                               java.lang.Object ctorArg,
                                                               @Nullable
                                                               java.lang.String errorMessageTemplate,
                                                               @Nullable
                                                               java.lang.Object... errorMessageArgs)
                                                        throws X extends java.lang.Throwable

reference为null时抛出 declareType 异常

类型参数:

T - 对象类型

X - 抛出异常类型

参数:

reference -

declareType - 异常类型,要求有两个参数的构造方法(ctorArg,String)或(String,ctorArg)

ctorArg - 异常类型构造方法的第一或第二个参数,另一个参数类型为String

errorMessageTemplate - 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).

返回:

T instance

抛出:

X

X extends java.lang.Throwable

checkNotNull

public static <T,X extends java.lang.Throwable> T checkNotNull(T reference,
                                                               java.lang.Class<X> declareType,
                                                               java.lang.Object ctorArg,
                                                               @Nullable
                                                               java.lang.String errorMessageTemplate,
                                                               @Nullable
                                                               java.lang.Object p1)
                                                        throws X extends java.lang.Throwable

reference为null时抛出 declareType 异常

SeecheckNotNull(Object, Class, Object, String, Object[]) for details.

返回:

always reference

抛出:

X

X extends java.lang.Throwable

checkNotNull

public static <T,X extends java.lang.Throwable> T checkNotNull(T reference,
                                                               java.lang.Class<X> declareType,
                                                               java.lang.Object ctorArg)
                                                        throws X extends java.lang.Throwable

reference为null时抛出 declareType 异常

类型参数:

X - 抛出异常类型

参数:

reference -

declareType - 异常类型

ctorArg - 异常类型构造方法的参数

返回:

always reference

抛出:

X

X extends java.lang.Throwable

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.

参数:

expression - a boolean expression

抛出:

java.lang.IllegalStateException - if expression is false

checkState

public static void checkState(boolean expression,
                              @Nullable
                              java.lang.String errorMessageTemplate,
                              @Nullable
                              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.

参数:

expression - a boolean expression

errorMessageTemplate - 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 false

java.lang.NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

checkArgument

public static void checkArgument(boolean expression)

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

参数:

expression - a boolean expression

抛出:

java.lang.IllegalArgumentException - if expression is false

checkArgument

public static void checkArgument(boolean expression,
                                 @Nullable
                                 java.lang.String errorMessageTemplate,
                                 @Nullable
                                 java.lang.Object... errorMessageArgs)

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

参数:

expression - a boolean expression

errorMessageTemplate - 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 false

java.lang.NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

checkNotNull

public static <T> T checkNotNull(T reference)

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

参数:

reference - an object reference

返回:

the non-null reference that was validated

抛出:

java.lang.NullPointerException - if reference is null

checkNotNull

public static <T> T checkNotNull(T reference,
                                 @Nullable
                                 java.lang.String errorMessageTemplate,
                                 @Nullable
                                 java.lang.Object... errorMessageArgs)

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

参数:

reference - an object reference

errorMessageTemplate - 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).

返回:

the non-null reference that was validated

抛出:

java.lang.NullPointerException - if reference is null

format

public static java.lang.String format(java.lang.String template,
                                      @Nullable
                                      java.lang.Object... args)

Substitutes each %s in template with an argument. These are matched by position: the first %s gets args[0], etc. If there are more arguments than placeholders, the unmatched arguments will be appended to the end of the formatted message in square braces.

参数:

template - a non-null string containing 0 or more %s placeholders.

args - the arguments to be substituted into the message template. Arguments are converted to strings using String.valueOf(Object). Arguments can be null.