javax.annotation.processing

Interface Messager

Contents

  • public interface Messager
    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.

    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.

    Since:
    1.6
    See Also:
    ProcessingEnvironment.getLocale()

    • Method Detail

      • printMessage

        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

        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

        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

        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

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/annotation/processing/messager.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut