001 /*
002 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.annotation.processing;
027
028 import javax.annotation.*;
029 import javax.tools.Diagnostic;
030 import javax.lang.model.element.*;
031
032 /**
033 * A {@code Messager} provides the way for an annotation processor to
034 * report error messages, warnings, and other notices. Elements,
035 * annotations, and annotation values can be passed to provide a
036 * location hint for the message. However, such location hints may be
037 * unavailable or only approximate.
038 *
039 * <p>Printing a message with an {@linkplain
040 * javax.tools.Diagnostic.Kind#ERROR error kind} will {@linkplain
041 * RoundEnvironment#errorRaised raise an error}.
042 *
043 * <p>Note that the messages "printed" by methods in this
044 * interface may or may not appear as textual output to a location
045 * like {@link System#out} or {@link System#err}. Implementations may
046 * choose to present this information in a different fashion, such as
047 * messages in a window.
048 *
049 * @author Joseph D. Darcy
050 * @author Scott Seligman
051 * @author Peter von der Ahé
052 * @version 1.13 07/05/05
053 * @see ProcessingEnvironment#getLocale
054 * @since 1.6
055 */
056 public interface Messager {
057 /**
058 * Prints a message of the specified kind.
059 *
060 * @param kind the kind of message
061 * @param msg the message, or an empty string if none
062 */
063 void printMessage(Diagnostic.Kind kind, CharSequence msg);
064
065 /**
066 * Prints a message of the specified kind at the location of the
067 * element.
068 *
069 * @param kind the kind of message
070 * @param msg the message, or an empty string if none
071 * @param e the element to use as a position hint
072 */
073 void printMessage(Diagnostic.Kind kind, CharSequence msg, Element e);
074
075 /**
076 * Prints a message of the specified kind at the location of the
077 * annotation mirror of the annotated element.
078 *
079 * @param kind the kind of message
080 * @param msg the message, or an empty string if none
081 * @param e the annotated element
082 * @param a the annotation to use as a position hint
083 */
084 void printMessage(Diagnostic.Kind kind, CharSequence msg,
085 Element e, AnnotationMirror a);
086
087 /**
088 * Prints a message of the specified kind at the location of the
089 * annotation value inside the annotation mirror of the annotated
090 * element.
091 *
092 * @param kind the kind of message
093 * @param msg the message, or an empty string if none
094 * @param e the annotated element
095 * @param a the annotation containing the annotation value
096 * @param v the annotation value to use as a position hint
097 */
098 void printMessage(Diagnostic.Kind kind, CharSequence msg,
099 Element e, AnnotationMirror a, AnnotationValue v);
100 }
|