JBoss Logging I18n Annotation Processor 1.0.3.Final-redhat-2

org.jboss.logging.processor.apt
Class ToolLogger

java.lang.Object
  extended by org.jboss.logging.processor.apt.ToolLogger

public final class ToolLogger
extends Object

A logger for logging messages for annotation processors.

Author:
James R. Perkins, Kevin Pollet - SERLI - (kevin.pollet@serli.com)

Method Summary
 void debug(Element element, String message)
          Prints a debug message.
 void debug(Element element, String messageFormat, Object... args)
          Prints a formatted debug message if debugging is enabled.
 void debug(String messageFormat, Object... args)
          Prints a formatted debug message if debugging is enabled.
 void error(Element element, String message)
          Prints a error message.
 void error(Element element, String messageFormat, Object... args)
          Prints a formatted error message.
 void error(Element element, Throwable cause)
          Prints an error message.
 void error(Element element, Throwable cause, String messageFormat, Object... args)
          Prints an error message.
 void error(String messageFormat, Object... args)
          Prints a formatted error message.
 void error(Throwable cause)
          Prints an error message.
 void error(Throwable cause, Element element, String message)
          Prints a error message.
 void error(Throwable cause, String messageFormat, Object... args)
          Prints an error message.
static ToolLogger getLogger(ProcessingEnvironment processingEnv)
          Creates a new tool logger.
 boolean isDebugEnabled()
          Returns true if debugging is enabled, otherwise false.
 void mandatoryWarning(Element element, String message)
          Prints a warning message.
 void mandatoryWarning(Element element, String messageFormat, Object... args)
          Prints a formatted warning message.
 void mandatoryWarning(String messageFormat, Object... args)
          Prints a formatted warning message.
 void note(Element element, String message)
          Prints a note message.
 void note(Element element, String messageFormat, Object... args)
          Prints a formatted note message.
 void note(String messageFormat, Object... args)
          Prints a formatted note message.
 void other(Element element, String message)
          Prints a message that does not fit the other types.
 void other(Element element, String messageFormat, Object... args)
          Prints a formatted message that does not fit the other types.
 void other(String messageFormat, Object... args)
          Prints a formatted message that does not fit the other types.
 void warn(Element element, String message)
          Prints a warning message.
 void warn(Element element, String messageFormat, Object... args)
          Prints a formatted warning message.
 void warn(String messageFormat, Object... args)
          Prints a formatted warning message.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

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(String messageFormat,
                 Object... args)
Prints a formatted note message.

Parameters:
messageFormat - the message format.
args - the format arguments.

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(String messageFormat,
                 Object... args)
Prints a formatted warning message.

Parameters:
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(String messageFormat,
                             Object... args)
Prints a formatted warning message.

Parameters:
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:
messageFormat - the message format.
element - the element that caused the warning.
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:
cause - the cause of the error.
element - the element that caused the error.

error

public void error(Element element,
                  Throwable cause,
                  String messageFormat,
                  Object... args)
Prints an error message.

Parameters:
cause - the cause of the error.
messageFormat - the message format.
element - the element that caused the warning.
args - the format arguments.

other

public void other(String messageFormat,
                  Object... args)
Prints a formatted message that does not fit the other types.

Parameters:
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.

JBoss Logging I18n Annotation Processor 1.0.3.Final-redhat-2

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.