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