APIdia Launch Partner
Top Description Methods
javax.annotation.processing

public Interface Messager

Imports
javax.tools.Diagnostic, javax.lang.model.element.*
A 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 error kind will raise an error.

API Note

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

Since
1.6
See Also
ProcessingEnvironment#getLocale

Method Summary

Modifier and TypeMethod and Description
public default void
printError(CharSequence
the message, or an empty string if none
msg)

Prints an error.

public default void
printError(CharSequence
the message, or an empty string if none
msg, Element
the element to use as a position hint
e)

Prints an error at the location of the element.

public void
printMessage(Diagnostic.Kind
the kind of message
kind, CharSequence
the message, or an empty string if none
msg)

Prints a message of the specified kind.

public void
printMessage(Diagnostic.Kind
the kind of message
kind, CharSequence
the message, or an empty string if none
msg, Element
the element to use as a position hint
e)

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

public void
printMessage(Diagnostic.Kind
the kind of message
kind, CharSequence
the message, or an empty string if none
msg, Element
the annotated element
e, AnnotationMirror
the annotation to use as a position hint
a)

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

public void
printMessage(Diagnostic.Kind
the kind of message
kind, CharSequence
the message, or an empty string if none
msg, Element
the annotated element
e, AnnotationMirror
the annotation containing the annotation value
a, AnnotationValue
the annotation value to use as a position hint
v)

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

public default void
printNote(CharSequence
the message, or an empty string if none
msg)

Prints a note.

public default void
printNote(CharSequence
the message, or an empty string if none
msg, Element
the element to use as a position hint
e)

Prints a note at the location of the element.

public default void
printWarning(CharSequence
the message, or an empty string if none
msg)

Prints a warning.

public default void
printWarning(CharSequence
the message, or an empty string if none
msg, Element
the element to use as a position hint
e)

Prints a warning at the location of the element.

Method Detail

printErrorback to summary
public default void printError(CharSequence msg)

Prints an error.

Implementation Specification

The default implementation is equivalent to printMessage(Diagnostic.Kind.ERROR, msg).

Parameters
msg:CharSequence

the message, or an empty string if none

Since
18
printErrorback to summary
public default void printError(CharSequence msg, Element e)

Prints an error at the location of the element.

Implementation Specification

The default implementation is equivalent to printMessage(Diagnostic.Kind.ERROR, msg, e).

Parameters
msg:CharSequence

the message, or an empty string if none

e:Element

the element to use as a position hint

Since
18
printMessageback to summary
public void printMessage(Diagnostic.Kind kind, CharSequence msg)

Prints a message of the specified kind.

Parameters
kind:Diagnostic.Kind

the kind of message

msg:CharSequence

the message, or an empty string if none

printMessageback to summary
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:Diagnostic.Kind

the kind of message

msg:CharSequence

the message, or an empty string if none

e:Element

the element to use as a position hint

printMessageback to summary
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:Diagnostic.Kind

the kind of message

msg:CharSequence

the message, or an empty string if none

e:Element

the annotated element

a:AnnotationMirror

the annotation to use as a position hint

printMessageback to summary
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:Diagnostic.Kind

the kind of message

msg:CharSequence

the message, or an empty string if none

e:Element

the annotated element

a:AnnotationMirror

the annotation containing the annotation value

v:AnnotationValue

the annotation value to use as a position hint

printNoteback to summary
public default void printNote(CharSequence msg)

Prints a note.

Implementation Specification

The default implementation is equivalent to printMessage(Diagnostic.Kind.NOTE, msg).

Parameters
msg:CharSequence

the message, or an empty string if none

Since
18
printNoteback to summary
public default void printNote(CharSequence msg, Element e)

Prints a note at the location of the element.

Implementation Specification

The default implementation is equivalent to printMessage(Diagnostic.Kind.NOTE, msg, e).

Parameters
msg:CharSequence

the message, or an empty string if none

e:Element

the element to use as a position hint

Since
18
printWarningback to summary
public default void printWarning(CharSequence msg)

Prints a warning.

Implementation Specification

The default implementation is equivalent to printMessage(Diagnostic.Kind.WARNING, msg).

Parameters
msg:CharSequence

the message, or an empty string if none

Since
18
printWarningback to summary
public default void printWarning(CharSequence msg, Element e)

Prints a warning at the location of the element.

Implementation Specification

The default implementation is equivalent to printMessage(Diagnostic.Kind.WARNING, msg, e).

Parameters
msg:CharSequence

the message, or an empty string if none

e:Element

the element to use as a position hint

Since
18