1 /* |
|
2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. 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. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package com.sun.tools.javadoc; |
|
27 |
|
28 import com.sun.javadoc.*; |
|
29 |
|
30 import com.sun.tools.javac.code.Attribute; |
|
31 import com.sun.tools.javac.code.Symbol.*; |
|
32 import com.sun.tools.javac.util.List; |
|
33 import com.sun.tools.javac.util.Pair; |
|
34 |
|
35 |
|
36 /** |
|
37 * Represents an annotation. |
|
38 * An annotation associates a value with each element of an annotation type. |
|
39 * Sure it ought to be called "Annotation", but that clashes with |
|
40 * java.lang.annotation.Annotation. |
|
41 * |
|
42 * <p><b>This is NOT part of any supported API. |
|
43 * If you write code that depends on this, you do so at your own risk. |
|
44 * This code and its internal interfaces are subject to change or |
|
45 * deletion without notice.</b> |
|
46 * |
|
47 * @author Scott Seligman |
|
48 * @since 1.5 |
|
49 */ |
|
50 |
|
51 public class AnnotationDescImpl implements AnnotationDesc { |
|
52 |
|
53 private final DocEnv env; |
|
54 private final Attribute.Compound annotation; |
|
55 |
|
56 |
|
57 AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) { |
|
58 this.env = env; |
|
59 this.annotation = annotation; |
|
60 } |
|
61 |
|
62 /** |
|
63 * Returns the annotation type of this annotation. |
|
64 */ |
|
65 public AnnotationTypeDoc annotationType() { |
|
66 ClassSymbol atsym = (ClassSymbol)annotation.type.tsym; |
|
67 if (annotation.type.isErroneous()) { |
|
68 env.warning(null, "javadoc.class_not_found", annotation.type.toString()); |
|
69 return new AnnotationTypeDocImpl(env, atsym); |
|
70 } else { |
|
71 return (AnnotationTypeDoc)env.getClassDoc(atsym); |
|
72 } |
|
73 } |
|
74 |
|
75 /** |
|
76 * Returns this annotation's elements and their values. |
|
77 * Only those explicitly present in the annotation are |
|
78 * included, not those assuming their default values. |
|
79 * Returns an empty array if there are none. |
|
80 */ |
|
81 public ElementValuePair[] elementValues() { |
|
82 List<Pair<MethodSymbol,Attribute>> vals = annotation.values; |
|
83 ElementValuePair res[] = new ElementValuePair[vals.length()]; |
|
84 int i = 0; |
|
85 for (Pair<MethodSymbol,Attribute> val : vals) { |
|
86 res[i++] = new ElementValuePairImpl(env, val.fst, val.snd); |
|
87 } |
|
88 return res; |
|
89 } |
|
90 |
|
91 /** |
|
92 * Check for the synthesized bit on the annotation. |
|
93 * |
|
94 * @return true if the annotation is synthesized. |
|
95 */ |
|
96 public boolean isSynthesized() { |
|
97 return annotation.isSynthesized(); |
|
98 } |
|
99 |
|
100 /** |
|
101 * Returns a string representation of this annotation. |
|
102 * String is of one of the forms: |
|
103 * <pre> |
|
104 * {@code @com.example.foo(name1=val1, name2=val2)} |
|
105 * {@code @com.example.foo(val)} |
|
106 * {@code @com.example.foo} |
|
107 * </pre> |
|
108 * Omit parens for marker annotations, and omit "value=" when allowed. |
|
109 */ |
|
110 @Override |
|
111 public String toString() { |
|
112 StringBuilder sb = new StringBuilder("@"); |
|
113 sb.append(annotation.type.tsym); |
|
114 |
|
115 ElementValuePair vals[] = elementValues(); |
|
116 if (vals.length > 0) { // omit parens for marker annotation |
|
117 sb.append('('); |
|
118 boolean first = true; |
|
119 for (ElementValuePair val : vals) { |
|
120 if (!first) { |
|
121 sb.append(", "); |
|
122 } |
|
123 first = false; |
|
124 |
|
125 String name = val.element().name(); |
|
126 if (vals.length == 1 && name.equals("value")) { |
|
127 sb.append(val.value()); |
|
128 } else { |
|
129 sb.append(val); |
|
130 } |
|
131 } |
|
132 sb.append(')'); |
|
133 } |
|
134 return sb.toString(); |
|
135 } |
|
136 |
|
137 |
|
138 /** |
|
139 * Represents an association between an annotation type element |
|
140 * and one of its values. |
|
141 */ |
|
142 public static class ElementValuePairImpl implements ElementValuePair { |
|
143 |
|
144 private final DocEnv env; |
|
145 private final MethodSymbol meth; |
|
146 private final Attribute value; |
|
147 |
|
148 ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) { |
|
149 this.env = env; |
|
150 this.meth = meth; |
|
151 this.value = value; |
|
152 } |
|
153 |
|
154 /** |
|
155 * Returns the annotation type element. |
|
156 */ |
|
157 public AnnotationTypeElementDoc element() { |
|
158 return env.getAnnotationTypeElementDoc(meth); |
|
159 } |
|
160 |
|
161 /** |
|
162 * Returns the value associated with the annotation type element. |
|
163 */ |
|
164 public AnnotationValue value() { |
|
165 return new AnnotationValueImpl(env, value); |
|
166 } |
|
167 |
|
168 /** |
|
169 * Returns a string representation of this pair |
|
170 * of the form "name=value". |
|
171 */ |
|
172 @Override |
|
173 public String toString() { |
|
174 return meth.name + "=" + value(); |
|
175 } |
|
176 } |
|
177 } |
|