Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/lang/model/element/AnnotationMirror.java@c75be5bc5283 (annotated)
src/share/classes/javax/lang/model/element/AnnotationMirror.java
Tue, 09 Oct 2012 19:10:00 -0700
- author
- jjg
- date
- Tue, 09 Oct 2012 19:10:00 -0700
- changeset 1357
- c75be5bc5283
- parent 554
- 9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8000663: clean up langtools imports
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.lang.model.element; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.util.Map; |
| duke@1 | 29 | import javax.lang.model.type.DeclaredType; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * Represents an annotation. An annotation associates a value with |
| duke@1 | 33 | * each element of an annotation type. |
| duke@1 | 34 | * |
| duke@1 | 35 | * <p> Annotations should be compared using the {@code equals} |
| duke@1 | 36 | * method. There is no guarantee that any particular annotation will |
| duke@1 | 37 | * always be represented by the same object. |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Joseph D. Darcy |
| duke@1 | 40 | * @author Scott Seligman |
| duke@1 | 41 | * @author Peter von der Ahé |
| duke@1 | 42 | * @since 1.6 |
| duke@1 | 43 | */ |
| duke@1 | 44 | public interface AnnotationMirror { |
| duke@1 | 45 | |
| duke@1 | 46 | /** |
| duke@1 | 47 | * Returns the type of this annotation. |
| duke@1 | 48 | * |
| duke@1 | 49 | * @return the type of this annotation |
| duke@1 | 50 | */ |
| duke@1 | 51 | DeclaredType getAnnotationType(); |
| duke@1 | 52 | |
| duke@1 | 53 | /** |
| duke@1 | 54 | * Returns the values of this annotation's elements. |
| duke@1 | 55 | * This is returned in the form of a map that associates elements |
| duke@1 | 56 | * with their corresponding values. |
| duke@1 | 57 | * Only those elements with values explicitly present in the |
| duke@1 | 58 | * annotation are included, not those that are implicitly assuming |
| duke@1 | 59 | * their default values. |
| duke@1 | 60 | * The order of the map matches the order in which the |
| duke@1 | 61 | * values appear in the annotation's source. |
| duke@1 | 62 | * |
| duke@1 | 63 | * <p>Note that an annotation mirror of a marker annotation type |
| duke@1 | 64 | * will by definition have an empty map. |
| duke@1 | 65 | * |
| duke@1 | 66 | * <p>To fill in default values, use {@link |
| duke@1 | 67 | * javax.lang.model.util.Elements#getElementValuesWithDefaults |
| duke@1 | 68 | * getElementValuesWithDefaults}. |
| duke@1 | 69 | * |
| duke@1 | 70 | * @return the values of this annotation's elements, |
| duke@1 | 71 | * or an empty map if there are none |
| duke@1 | 72 | */ |
| duke@1 | 73 | Map<? extends ExecutableElement, ? extends AnnotationValue> getElementValues(); |
| duke@1 | 74 | } |
