src/share/classes/javax/annotation/processing/Messager.java

Thu, 31 Aug 2017 15:17:03 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:17:03 +0800
changeset 2525
2eb010b6cb22
parent 554
9d9f26857129
parent 0
959103a6100f
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package javax.annotation.processing;
aoqi@0 27
aoqi@0 28 import javax.annotation.*;
aoqi@0 29 import javax.tools.Diagnostic;
aoqi@0 30 import javax.lang.model.element.*;
aoqi@0 31
aoqi@0 32 /**
aoqi@0 33 * A {@code Messager} provides the way for an annotation processor to
aoqi@0 34 * report error messages, warnings, and other notices. Elements,
aoqi@0 35 * annotations, and annotation values can be passed to provide a
aoqi@0 36 * location hint for the message. However, such location hints may be
aoqi@0 37 * unavailable or only approximate.
aoqi@0 38 *
aoqi@0 39 * <p>Printing a message with an {@linkplain
aoqi@0 40 * javax.tools.Diagnostic.Kind#ERROR error kind} will {@linkplain
aoqi@0 41 * RoundEnvironment#errorRaised raise an error}.
aoqi@0 42 *
aoqi@0 43 * <p>Note that the messages &quot;printed&quot; by methods in this
aoqi@0 44 * interface may or may not appear as textual output to a location
aoqi@0 45 * like {@link System#out} or {@link System#err}. Implementations may
aoqi@0 46 * choose to present this information in a different fashion, such as
aoqi@0 47 * messages in a window.
aoqi@0 48 *
aoqi@0 49 * @author Joseph D. Darcy
aoqi@0 50 * @author Scott Seligman
aoqi@0 51 * @author Peter von der Ah&eacute;
aoqi@0 52 * @see ProcessingEnvironment#getLocale
aoqi@0 53 * @since 1.6
aoqi@0 54 */
aoqi@0 55 public interface Messager {
aoqi@0 56 /**
aoqi@0 57 * Prints a message of the specified kind.
aoqi@0 58 *
aoqi@0 59 * @param kind the kind of message
aoqi@0 60 * @param msg the message, or an empty string if none
aoqi@0 61 */
aoqi@0 62 void printMessage(Diagnostic.Kind kind, CharSequence msg);
aoqi@0 63
aoqi@0 64 /**
aoqi@0 65 * Prints a message of the specified kind at the location of the
aoqi@0 66 * element.
aoqi@0 67 *
aoqi@0 68 * @param kind the kind of message
aoqi@0 69 * @param msg the message, or an empty string if none
aoqi@0 70 * @param e the element to use as a position hint
aoqi@0 71 */
aoqi@0 72 void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e);
aoqi@0 73
aoqi@0 74 /**
aoqi@0 75 * Prints a message of the specified kind at the location of the
aoqi@0 76 * annotation mirror of the annotated element.
aoqi@0 77 *
aoqi@0 78 * @param kind the kind of message
aoqi@0 79 * @param msg the message, or an empty string if none
aoqi@0 80 * @param e the annotated element
aoqi@0 81 * @param a the annotation to use as a position hint
aoqi@0 82 */
aoqi@0 83 void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a);
aoqi@0 84
aoqi@0 85 /**
aoqi@0 86 * Prints a message of the specified kind at the location of the
aoqi@0 87 * annotation value inside the annotation mirror of the annotated
aoqi@0 88 * element.
aoqi@0 89 *
aoqi@0 90 * @param kind the kind of message
aoqi@0 91 * @param msg the message, or an empty string if none
aoqi@0 92 * @param e the annotated element
aoqi@0 93 * @param a the annotation containing the annotation value
aoqi@0 94 * @param v the annotation value to use as a position hint
aoqi@0 95 */
aoqi@0 96 void printMessage(Diagnostic.Kind kind,
aoqi@0 97 CharSequence msg,
aoqi@0 98 Element e,
aoqi@0 99 AnnotationMirror a,
aoqi@0 100 AnnotationValue v);
aoqi@0 101 }

mercurial