1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.javadoc;
import com.google.doclava.annotation.Unused;
import com.google.doclava.annotation.Used;
/**
* Represents an annotation.
* An annotation associates a value with each element of an annotation type.
*
* @author Scott Seligman
* @since 1.5
*/
public interface AnnotationDesc {
/**
* Returns the annotation type of this annotation.
*
* @return the annotation type of this annotation.
*/
@Used
AnnotationTypeDoc annotationType();
/**
* Returns this annotation's elements and their values.
* Only those explicitly present in the annotation are
* included, not those assuming their default values.
* Returns an empty array if there are none.
*
* @return this annotation's elements and their values.
*/
@Used
ElementValuePair[] elementValues();
/**
* Check for the synthesized bit on the annotation.
*
* @return true if the annotation is synthesized.
*/
@Unused
boolean isSynthesized();
/**
* Represents an association between an annotation type element
* and one of its values.
*
* @author Scott Seligman
* @since 1.5
*/
interface ElementValuePair {
/**
* Returns the annotation type element.
*
* @return the annotation type element.
*/
@Used
AnnotationTypeElementDoc element();
/**
* Returns the value associated with the annotation type element.
*
* @return the value associated with the annotation type element.
*/
@Used
AnnotationValue value();
}
}
|
