Tue, 23 Oct 2012 13:20:37 -0700
8000741: refactor javadoc to use abstraction to handle relative paths
Reviewed-by: darcy
1 /*
2 * Copyright (c) 2003, 2012, 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 */
26 package com.sun.tools.javadoc;
28 import com.sun.javadoc.*;
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;
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 */
51 public class AnnotationDescImpl implements AnnotationDesc {
53 private final DocEnv env;
54 private final Attribute.Compound annotation;
57 AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) {
58 this.env = env;
59 this.annotation = annotation;
60 }
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 }
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 }
91 /**
92 * Returns a string representation of this annotation.
93 * String is of one of the forms:
94 * @com.example.foo(name1=val1, name2=val2)
95 * @com.example.foo(val)
96 * @com.example.foo
97 * Omit parens for marker annotations, and omit "value=" when allowed.
98 */
99 @Override
100 public String toString() {
101 StringBuilder sb = new StringBuilder("@");
102 sb.append(annotation.type.tsym);
104 ElementValuePair vals[] = elementValues();
105 if (vals.length > 0) { // omit parens for marker annotation
106 sb.append('(');
107 boolean first = true;
108 for (ElementValuePair val : vals) {
109 if (!first) {
110 sb.append(", ");
111 }
112 first = false;
114 String name = val.element().name();
115 if (vals.length == 1 && name.equals("value")) {
116 sb.append(val.value());
117 } else {
118 sb.append(val);
119 }
120 }
121 sb.append(')');
122 }
123 return sb.toString();
124 }
127 /**
128 * Represents an association between an annotation type element
129 * and one of its values.
130 */
131 public static class ElementValuePairImpl implements ElementValuePair {
133 private final DocEnv env;
134 private final MethodSymbol meth;
135 private final Attribute value;
137 ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) {
138 this.env = env;
139 this.meth = meth;
140 this.value = value;
141 }
143 /**
144 * Returns the annotation type element.
145 */
146 public AnnotationTypeElementDoc element() {
147 return env.getAnnotationTypeElementDoc(meth);
148 }
150 /**
151 * Returns the value associated with the annotation type element.
152 */
153 public AnnotationValue value() {
154 return new AnnotationValueImpl(env, value);
155 }
157 /**
158 * Returns a string representation of this pair
159 * of the form "name=value".
160 */
161 @Override
162 public String toString() {
163 return meth.name + "=" + value();
164 }
165 }
166 }