This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.annotation.processing
interface Messager


public interface Messager

A {@code Messager} provides the way for an annotation processor to report error messages, warnings, and other notices. Elements, annotations, and annotation values can be passed to provide a location hint for the message. However, such location hints may be unavailable or only approximate.

Printing a message with an {@linkplain javax.tools.Diagnostic.Kind#ERROR error kind} will {@linkplain RoundEnvironment#errorRaised raise an error}.

Note that the messages "printed" by methods in this interface may or may not appear as textual output to a location like {@link System#out} or {@link System#err}. Implementations may choose to present this information in a different fashion, such as messages in a window.


Method Summary
 void

          Prints a message of the specified kind.
 void

          Prints a message of the specified kind at the location of the element.
 void

          Prints a message of the specified kind at the location of the annotation mirror of the annotated element.
 void

          Prints a message of the specified kind at the location of the annotation value inside the annotation mirror of the annotated element.
 

Method Detail

printMessage

public void printMessage(Diagnostic.Kind kind,
                         CharSequence msg)
Prints a message of the specified kind.

Parameters:
kind - the kind of message
msg - the message, or an empty string if none

printMessage

public void printMessage(Diagnostic.Kind kind,
                         CharSequence msg,
                         Element e)
Prints a message of the specified kind at the location of the element.

Parameters:
kind - the kind of message
msg - the message, or an empty string if none
e - the element to use as a position hint

printMessage

public void printMessage(Diagnostic.Kind kind,
                         CharSequence msg,
                         Element e,
                         AnnotationMirror a)
Prints a message of the specified kind at the location of the annotation mirror of the annotated element.

Parameters:
kind - the kind of message
msg - the message, or an empty string if none
e - the annotated element
a - the annotation to use as a position hint

printMessage

public void printMessage(Diagnostic.Kind kind,
                         CharSequence msg,
                         Element e,
                         AnnotationMirror a,
                         AnnotationValue v)
Prints a message of the specified kind at the location of the annotation value inside the annotation mirror of the annotated element.

Parameters:
kind - the kind of message
msg - the message, or an empty string if none
e - the annotated element
a - the annotation containing the annotation value
v - the annotation value to use as a position hint


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.