File Doc Category Size Date Package
Messager.java API Doc Java SE 6 API 2892 Tue Jun 10 00:26:04 BST 2008 javax.annotation.processing

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.

author: Joseph D. Darcy
author: Scott Seligman
author: Peter von der Ahé
version: 1.7 06/08/28
see: ProcessingEnvironment#getLocale
since: 1.6

Fields Summary
Constructors Summary
Methods Summary
public void printMessage(javax.tools.Diagnostic$Kind kind, java.lang.CharSequence msg)
Prints a message of the specified kind.
param
kind the kind of message
param
msg the message, or an empty string if none
public void printMessage(javax.tools.Diagnostic$Kind kind, java.lang.CharSequence msg, javax.lang.model.element.Element e)
Prints a message of the specified kind at the location of the element.
param
kind the kind of message
param
msg the message, or an empty string if none
param
e the element to use as a position hint
public void printMessage(javax.tools.Diagnostic$Kind kind, java.lang.CharSequence msg, javax.lang.model.element.Element e, javax.lang.model.element.AnnotationMirror a)
Prints a message of the specified kind at the location of the annotation mirror of the annotated element.
param
kind the kind of message
param
msg the message, or an empty string if none
param
e the annotated element
param
a the annotation to use as a position hint
public void printMessage(javax.tools.Diagnostic$Kind kind, java.lang.CharSequence msg, javax.lang.model.element.Element e, javax.lang.model.element.AnnotationMirror a, javax.lang.model.element.AnnotationValue v)
Prints a message of the specified kind at the location of the annotation value inside the annotation mirror of the annotated element.
param
kind the kind of message
param
msg the message, or an empty string if none
param
e the annotated element
param
a the annotation containing the annotation value
param
v the annotation value to use as a position hint