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.
System.out
or System.err
. Implementations may choose to present this information in a different fashion, such as messages in a window.Modifier and Type | Method | Description |
---|---|---|
default void |
printError |
Prints an error. |
default void |
printError |
Prints an error at the location of the element. |
void |
printMessage |
Prints a message of the specified kind. |
void |
printMessage |
Prints a message of the specified kind at the location of the element. |
void |
printMessage |
Prints a message of the specified kind at the location of the annotation mirror of the annotated element. |
void |
printMessage |
Prints a message of the specified kind at the location of the annotation value inside the annotation mirror of the annotated element. |
default void |
printNote |
Prints a note. |
default void |
printNote |
Prints a note at the location of the element. |
default void |
printWarning |
Prints a warning. |
default void |
printWarning |
Prints a warning at the location of the 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 hintdefault void printError(CharSequence msg)
printMessage(Diagnostic.Kind.ERROR, msg)
.msg
- the message, or an empty string if nonedefault void printError(CharSequence msg, Element e)
printMessage(Diagnostic.Kind.ERROR, msg, e)
.msg
- the message, or an empty string if nonee
- the element to use as a position hintdefault void printWarning(CharSequence msg)
printMessage(Diagnostic.Kind.WARNING, msg)
.msg
- the message, or an empty string if nonedefault void printWarning(CharSequence msg, Element e)
printMessage(Diagnostic.Kind.WARNING, msg, e)
.msg
- the message, or an empty string if nonee
- the element to use as a position hintdefault void printNote(CharSequence msg)
printMessage(Diagnostic.Kind.NOTE, msg)
.msg
- the message, or an empty string if nonedefault void printNote(CharSequence msg, Element e)
printMessage(Diagnostic.Kind.NOTE, msg, e)
.msg
- the message, or an empty string if nonee
- the element to use as a position hint
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/annotation/processing/Messager.html