src/share/classes/javax/lang/model/element/AnnotationMirror.java

changeset 1
9a66ca7c79fa
child 554
9d9f26857129
equal deleted inserted replaced
-1:000000000000 1:9a66ca7c79fa
1 /*
2 * Copyright 2005-2006 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.lang.model.element;
27
28 import java.util.Map;
29 import javax.lang.model.type.DeclaredType;
30
31 /**
32 * Represents an annotation. An annotation associates a value with
33 * each element of an annotation type.
34 *
35 * <p> Annotations should be compared using the {@code equals}
36 * method. There is no guarantee that any particular annotation will
37 * always be represented by the same object.
38 *
39 * @author Joseph D. Darcy
40 * @author Scott Seligman
41 * @author Peter von der Ah&eacute;
42 * @since 1.6
43 */
44 public interface AnnotationMirror {
45
46 /**
47 * Returns the type of this annotation.
48 *
49 * @return the type of this annotation
50 */
51 DeclaredType getAnnotationType();
52
53 /**
54 * Returns the values of this annotation's elements.
55 * This is returned in the form of a map that associates elements
56 * with their corresponding values.
57 * Only those elements with values explicitly present in the
58 * annotation are included, not those that are implicitly assuming
59 * their default values.
60 * The order of the map matches the order in which the
61 * values appear in the annotation's source.
62 *
63 * <p>Note that an annotation mirror of a marker annotation type
64 * will by definition have an empty map.
65 *
66 * <p>To fill in default values, use {@link
67 * javax.lang.model.util.Elements#getElementValuesWithDefaults
68 * getElementValuesWithDefaults}.
69 *
70 * @return the values of this annotation's elements,
71 * or an empty map if there are none
72 */
73 Map<? extends ExecutableElement, ? extends AnnotationValue> getElementValues();
74 }

mercurial