Package dagger.hilt.processor.internal

Class ProcessorErrors

java.lang.Object
dagger.hilt.processor.internal.ProcessorErrors
public final class ProcessorErrors extends Object
Static helper methods for throwing errors during code generation.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    checkState(boolean expression, androidx.room.compiler.processing.XElement badElement, 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, androidx.room.compiler.processing.XElement badElement, String errorMessageTemplate, 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, 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, String errorMessageTemplate, 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
    checkStateX(boolean expression, Collection<? extends androidx.room.compiler.processing.XElement> badElements, String errorMessageTemplate, 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 Details

    • checkState

      public static void checkState(boolean expression, @Nullable 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
      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, @Nullable @FormatString String errorMessageTemplate, @Nullable 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
      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
      NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

    • checkState

      public static void checkState(boolean expression, androidx.room.compiler.processing.XElement badElement, @Nullable 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, androidx.room.compiler.processing.XElement badElement, @Nullable @FormatString String errorMessageTemplate, @Nullable 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
      NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

    • checkStateX

      @FormatMethod public static void checkStateX(boolean expression, Collection<? extends androidx.room.compiler.processing.XElement> badElements, @Nullable @FormatString String errorMessageTemplate, @Nullable 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
      NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)