public interface Messager
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.
Note that 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.
ProcessingEnvironment.getLocale() | Modifier and Type | Method and Description |
|---|---|
void |
printMessage (Diagnostic.Kind kind,
CharSequence msg)
Prints a message of the specified kind.
|
void |
printMessage (Diagnostic.Kind kind,
CharSequence msg,
Element e)
Prints a message of the specified kind at the location of the
element.
|
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.
|
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.
|
void printMessage(Diagnostic.Kind kind, CharSequence msg)
kind - the kind of messagemsg - the message, or an empty string if nonevoid printMessage(Diagnostic.Kind kind, CharSequence msg, Element e)
kind - the kind of messagemsg - the message, or an empty string if nonee - the element to use as a position hintvoid printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a)
kind - the kind of messagemsg - the message, or an empty string if nonee - the annotated elementa - the annotation to use as a position hintvoid printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a, AnnotationValue v)
kind - the kind of messagemsg - the message, or an empty string if nonee - the annotated elementa - the annotation containing the annotation valuev - the annotation value to use as a position hint Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.