Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/mirror/declaration/AnnotationMirror.java@eff38cc97183 (annotated)
src/share/classes/com/sun/mirror/declaration/AnnotationMirror.java
Tue, 16 Sep 2008 18:35:18 -0700
- author
- jjg
- date
- Tue, 16 Sep 2008 18:35:18 -0700
- changeset 113
- eff38cc97183
- parent 1
- 9a66ca7c79fa
- child 331
- d043adadc8b6
- permissions
- -rw-r--r--
6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
Reviewed-by: darcy, mcimadamore
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 2004 Sun Microsystems, Inc. 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 |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun 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 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.mirror.declaration; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.util.Map; |
| duke@1 | 29 | import com.sun.mirror.type.AnnotationType; |
| duke@1 | 30 | import com.sun.mirror.util.SourcePosition; |
| duke@1 | 31 | |
| duke@1 | 32 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * Represents an annotation. An annotation associates a value with |
| duke@1 | 35 | * each element of an annotation type. |
| duke@1 | 36 | * |
| duke@1 | 37 | * <p> Annotations should not be compared using reference-equality |
| duke@1 | 38 | * ("<tt>==</tt>"). There is no guarantee that any particular |
| duke@1 | 39 | * annotation will always be represented by the same object. |
| duke@1 | 40 | * |
| duke@1 | 41 | * @author Joseph D. Darcy |
| duke@1 | 42 | * @author Scott Seligman |
| duke@1 | 43 | * @since 1.5 |
| duke@1 | 44 | */ |
| duke@1 | 45 | |
| duke@1 | 46 | public interface AnnotationMirror { |
| duke@1 | 47 | |
| duke@1 | 48 | /** |
| duke@1 | 49 | * Returns the annotation type of this annotation. |
| duke@1 | 50 | * |
| duke@1 | 51 | * @return the annotation type of this annotation |
| duke@1 | 52 | */ |
| duke@1 | 53 | AnnotationType getAnnotationType(); |
| duke@1 | 54 | |
| duke@1 | 55 | /** |
| duke@1 | 56 | * Returns the source position of the beginning of this annotation. |
| duke@1 | 57 | * Returns null if the position is unknown or not applicable. |
| duke@1 | 58 | * |
| duke@1 | 59 | * <p>This source position is intended for use in providing diagnostics, |
| duke@1 | 60 | * and indicates only approximately where an annotation begins. |
| duke@1 | 61 | * |
| duke@1 | 62 | * @return the source position of the beginning of this annotation or |
| duke@1 | 63 | * null if the position is unknown or not applicable |
| duke@1 | 64 | */ |
| duke@1 | 65 | SourcePosition getPosition(); |
| duke@1 | 66 | |
| duke@1 | 67 | /** |
| duke@1 | 68 | * Returns this annotation's elements and their values. |
| duke@1 | 69 | * This is returned in the form of a map that associates elements |
| duke@1 | 70 | * with their corresponding values. |
| duke@1 | 71 | * Only those elements and values explicitly present in the |
| duke@1 | 72 | * annotation are included, not those that are implicitly assuming |
| duke@1 | 73 | * their default values. |
| duke@1 | 74 | * The order of the map matches the order in which the |
| duke@1 | 75 | * elements appear in the annotation's source. |
| duke@1 | 76 | * |
| duke@1 | 77 | * @return this annotation's elements and their values, |
| duke@1 | 78 | * or an empty map if there are none |
| duke@1 | 79 | */ |
| duke@1 | 80 | Map<AnnotationTypeElementDeclaration, AnnotationValue> getElementValues(); |
| duke@1 | 81 | } |
