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