01: /*
02: * @(#)AnnotationMirror.java 1.5 04/07/16
03: *
04: * Copyright (c) 2004, Sun Microsystems, Inc.
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions are met:
09: *
10: * * Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * * Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * * Neither the name of the Sun Microsystems, Inc. nor the names of
16: * its contributors may be used to endorse or promote products derived from
17: * this software without specific prior written permission.
18: *
19: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20: * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21: * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
23: * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: */
31:
32: package com.sun.mirror.declaration;
33:
34: import java.util.Map;
35: import com.sun.mirror.type.AnnotationType;
36: import com.sun.mirror.util.SourcePosition;
37:
38: /**
39: * Represents an annotation. An annotation associates a value with
40: * each element of an annotation type.
41: *
42: * <p> Annotations should not be compared using reference-equality
43: * ("<tt>==</tt>"). There is no guarantee that any particular
44: * annotation will always be represented by the same object.
45: *
46: * @author Joseph D. Darcy
47: * @author Scott Seligman
48: * @version 1.5 04/07/16
49: * @since 1.5
50: */
51:
52: public interface AnnotationMirror {
53:
54: /**
55: * Returns the annotation type of this annotation.
56: *
57: * @return the annotation type of this annotation
58: */
59: AnnotationType getAnnotationType();
60:
61: /**
62: * Returns the source position of the beginning of this annotation.
63: * Returns null if the position is unknown or not applicable.
64: *
65: * <p>This source position is intended for use in providing diagnostics,
66: * and indicates only approximately where an annotation begins.
67: *
68: * @return the source position of the beginning of this annotation or
69: * null if the position is unknown or not applicable
70: */
71: SourcePosition getPosition();
72:
73: /**
74: * Returns this annotation's elements and their values.
75: * This is returned in the form of a map that associates elements
76: * with their corresponding values.
77: * Only those elements and values explicitly present in the
78: * annotation are included, not those that are implicitly assuming
79: * their default values.
80: * The order of the map matches the order in which the
81: * elements appear in the annotation's source.
82: *
83: * @return this annotation's elements and their values,
84: * or an empty map if there are none
85: */
86: Map<AnnotationTypeElementDeclaration, AnnotationValue> getElementValues();
87: }
|