dagger.hilt.processor.internal

Class ProcessorErrors

java.lang.Object

dagger.hilt.processor.internal.ProcessorErrors

public final class ProcessorErrors
extends java.lang.Object

Static helper methods for throwing errors during code generation.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Method Detail

checkState

public static void checkState(boolean expression,
                              javax.lang.model.element.Element badElement,
                              @Nullable
                              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.

Parameters:

expression - a boolean expression

badElement - the element that was at fault

errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)

Throws:

BadInputException - if expression is false

checkState

@FormatMethod
public static void checkState(boolean expression,
                                            javax.lang.model.element.Element badElement,
                                            @Nullable @FormatString
                                            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.

e.g. checkState(foo.isABar(), "Failed because of %s is not a bar", foo);

Parameters:

expression - a boolean expression

badElement - the element that was at fault

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

Throws:

BadInputException - if expression is false

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

checkState

public static void checkState(boolean expression,
                              java.util.Collection<? extends javax.lang.model.element.Element> badElements,
                              @Nullable
                              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.

Parameters:

expression - a boolean expression

badElements - the element that were at fault

errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)

Throws:

BadInputException - if expression is false

checkState

@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)

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Parameters:

expression - a boolean expression

badElements - the elements that were at fault

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

Throws:

BadInputException - if expression is false

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

checkNotErrorKind

public 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.

Parameters:

element - the element to check

Throws:

ErrorTypeException - if element inherits from an error kind.