Class ToolLogger

java.lang.Object
org.jboss.logging.processor.apt.ToolLogger
public final class ToolLogger extends Object
A logger for logging messages for annotation processors.

  • Field Details

    • messager

      private final Messager messager

    • isDebugEnabled

      private final boolean isDebugEnabled

  • Constructor Details

    • ToolLogger

      private ToolLogger(Messager messager, boolean isDebugEnabled)

  • Method Details

    • getLogger

      public static ToolLogger getLogger(ProcessingEnvironment processingEnv)
      Creates a new tool logger.
      Parameters:
      processingEnv - the processing environment
      Returns:
      a new tool logger

    • isDebugEnabled

      public boolean isDebugEnabled()
      Returns true if debugging is enabled, otherwise false.

      It is not necessary to invoke this method before invoking debug methods. The debug methods will only log messages if debugging is enabled.

      Returns:
      true if debugging is enabled, otherwise false.

    • note

      public void note(Element element, String message)
      Prints a note message.
      Parameters:
      element - the element to print with the note.
      message - the message.

    • note

      public void note(Element element, String messageFormat, Object... args)
      Prints a formatted note message.
      Parameters:
      element - the element to print with the note.
      messageFormat - the message format.
      args - the format arguments.

    • debug

      public void debug(String messageFormat, Object... args)
      Prints a formatted debug message if debugging is enabled.
      Parameters:
      messageFormat - the message format.
      args - the format arguments.

    • debug

      public void debug(Element element, String message)
      Prints a debug message.
      Parameters:
      element - the element to print with the note.
      message - the message.

    • debug

      public void debug(Element element, String messageFormat, Object... args)
      Prints a formatted debug message if debugging is enabled.
      Parameters:
      element - the element to print with the note.
      messageFormat - the message format.
      args - the format arguments.

    • warn

      public void warn(Element element, String message)
      Prints a warning message.
      Parameters:
      element - the element to print with the message.
      message - the message.

    • warn

      public void warn(Element element, String messageFormat, Object... args)
      Prints a formatted warning message.
      Parameters:
      element - the element that caused the warning.
      messageFormat - the message format.
      args - the format arguments.

    • mandatoryWarning

      public void mandatoryWarning(Element element, String message)
      Prints a warning message.
      Parameters:
      element - the element to print with the message.
      message - the message.

    • mandatoryWarning

      public void mandatoryWarning(Element element, String messageFormat, Object... args)
      Prints a formatted warning message.
      Parameters:
      element - the element that caused the warning.
      messageFormat - the message format.
      args - the format arguments.

    • error

      public void error(String messageFormat, Object... args)
      Prints a formatted error message.
      Parameters:
      messageFormat - the message format.
      args - the format arguments.

    • error

      public void error(Element element, String message)
      Prints a error message.
      Parameters:
      element - the element to print with the message.
      message - the message.

    • error

      public void error(Element element, String messageFormat, Object... args)
      Prints a formatted error message.
      Parameters:
      element - the element that caused the warning.
      messageFormat - the message format.
      args - the format arguments.

    • error

      public void error(Throwable cause)
      Prints an error message.
      Parameters:
      cause - the cause of the error.

    • error

      public void error(Throwable cause, Element element, String message)
      Prints a error message.
      Parameters:
      cause - the cause of the error.
      element - the element to print with the message.
      message - the message.

    • error

      public void error(Throwable cause, String messageFormat, Object... args)
      Prints an error message.
      Parameters:
      cause - the cause of the error.
      messageFormat - the message format.
      args - the format arguments.

    • error

      public void error(Element element, Throwable cause)
      Prints an error message.
      Parameters:
      element - the element that caused the error.
      cause - the cause of the error.

    • error

      public void error(Element element, Throwable cause, String messageFormat, Object... args)
      Prints an error message.
      Parameters:
      element - the element that caused the warning.
      cause - the cause of the error.
      messageFormat - the message format.
      args - the format arguments.

    • other

      public void other(Element element, String message)
      Prints a message that does not fit the other types.
      Parameters:
      element - the element to print with the message.
      message - the message.

    • other

      public void other(Element element, String messageFormat, Object... args)
      Prints a formatted message that does not fit the other types.
      Parameters:
      element - the element to print with the note.
      messageFormat - the message format.
      args - the format arguments.

    • log

      private void log(Diagnostic.Kind kind, Element element, String message)

    • log

      private void log(Diagnostic.Kind kind, Element element, String messageFormat, Object... args)

    • log

      private void log(Diagnostic.Kind kind, Element element, Throwable cause, String messageFormat, Object... args)

    • log

      private void log(Diagnostic.Kind kind, Element element, Throwable cause, String message)

    • stackTraceToString

      public static String stackTraceToString(Throwable t)
      Converts a stack trace to string output.
      Parameters:
      t - the stack trace to convert.
      Returns:
      a string version of the stack trace.

    • getElement

      private static Element getElement(Element element)