public final class ProcessorErrors
extends java.lang.Object
| Modifier and Type | Method and Description |
|---|---|
static void |
checkNotErrorKind(javax.lang.model.element.TypeElement element)
Ensures that the given element is not an error kind and does not inherit from an error kind.
|
static void |
checkState(boolean expression,
java.util.Collection<? extends javax.lang.model.element.Element> badElements,
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.util.Collection<? extends javax.lang.model.element.Element> badElements,
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 void |
checkState(boolean expression,
javax.lang.model.element.Element badElement,
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,
javax.lang.model.element.Element badElement,
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 void checkState(boolean expression,
javax.lang.model.element.Element badElement,
@Nullable
java.lang.Object errorMessage)
expression - a boolean expressionbadElement - the element that was at faulterrorMessage - the exception message to use if the check fails; will be converted to a
string using String.valueOf(Object)BadInputException - if expression is false@FormatMethod
public static void checkState(boolean expression,
javax.lang.model.element.Element badElement,
@Nullable @FormatString
java.lang.String errorMessageTemplate,
@Nullable
java.lang.Object... errorMessageArgs)
e.g. checkState(foo.isABar(), "Failed because of %s is not a bar", foo);
expression - a boolean expressionbadElement - the element that was at faulterrorMessageTemplate - 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).BadInputException - 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,
java.util.Collection<? extends javax.lang.model.element.Element> badElements,
@Nullable
java.lang.Object errorMessage)
expression - a boolean expressionbadElements - the element that were at faulterrorMessage - the exception message to use if the check fails; will be converted to a
string using String.valueOf(Object)BadInputException - if expression is false@FormatMethod
public static void checkState(boolean expression,
java.util.Collection<? extends javax.lang.model.element.Element> badElements,
@Nullable @FormatString
java.lang.String errorMessageTemplate,
@Nullable
java.lang.Object... errorMessageArgs)
expression - a boolean expressionbadElements - the elements that were at faulterrorMessageTemplate - 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).BadInputException - 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 checkNotErrorKind(javax.lang.model.element.TypeElement element)
element - the element to checkErrorTypeException - if element inherits from an error kind.