0N/A/*
3002N/A * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage javax.annotation.processing;
0N/A
0N/Aimport javax.annotation.*;
0N/Aimport javax.tools.Diagnostic;
0N/Aimport javax.lang.model.element.*;
0N/A
0N/A/**
0N/A * A {@code Messager} provides the way for an annotation processor to
0N/A * report error messages, warnings, and other notices. Elements,
0N/A * annotations, and annotation values can be passed to provide a
0N/A * location hint for the message. However, such location hints may be
0N/A * unavailable or only approximate.
0N/A *
0N/A * <p>Printing a message with an {@linkplain
0N/A * javax.tools.Diagnostic.Kind#ERROR error kind} will {@linkplain
0N/A * RoundEnvironment#errorRaised raise an error}.
0N/A *
0N/A * <p>Note that the messages &quot;printed&quot; by methods in this
0N/A * interface may or may not appear as textual output to a location
0N/A * like {@link System#out} or {@link System#err}. Implementations may
0N/A * choose to present this information in a different fashion, such as
0N/A * messages in a window.
0N/A *
0N/A * @author Joseph D. Darcy
0N/A * @author Scott Seligman
0N/A * @author Peter von der Ah&eacute;
0N/A * @see ProcessingEnvironment#getLocale
0N/A * @since 1.6
0N/A */
0N/Apublic interface Messager {
0N/A /**
0N/A * Prints a message of the specified kind.
0N/A *
0N/A * @param kind the kind of message
0N/A * @param msg the message, or an empty string if none
0N/A */
0N/A void printMessage(Diagnostic.Kind kind, CharSequence msg);
0N/A
0N/A /**
0N/A * Prints a message of the specified kind at the location of the
0N/A * element.
0N/A *
0N/A * @param kind the kind of message
0N/A * @param msg the message, or an empty string if none
0N/A * @param e the element to use as a position hint
0N/A */
0N/A void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e);
0N/A
0N/A /**
0N/A * Prints a message of the specified kind at the location of the
0N/A * annotation mirror of the annotated element.
0N/A *
0N/A * @param kind the kind of message
0N/A * @param msg the message, or an empty string if none
0N/A * @param e the annotated element
0N/A * @param a the annotation to use as a position hint
0N/A */
0N/A void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a);
0N/A
0N/A /**
0N/A * Prints a message of the specified kind at the location of the
0N/A * annotation value inside the annotation mirror of the annotated
0N/A * element.
0N/A *
0N/A * @param kind the kind of message
0N/A * @param msg the message, or an empty string if none
0N/A * @param e the annotated element
0N/A * @param a the annotation containing the annotation value
0N/A * @param v the annotation value to use as a position hint
0N/A */
0N/A void printMessage(Diagnostic.Kind kind,
0N/A CharSequence msg,
0N/A Element e,
0N/A AnnotationMirror a,
0N/A AnnotationValue v);
0N/A}
0N/A