Thu, 15 Nov 2012 09:18:36 -0800
8000800: javadoc uses static non-final fields
Reviewed-by: bpatel
duke@1 | 1 | /* |
jjg@1357 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.javadoc; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.javadoc.*; |
duke@1 | 29 | |
duke@1 | 30 | import com.sun.tools.javac.code.Attribute; |
duke@1 | 31 | import com.sun.tools.javac.code.Symbol.*; |
duke@1 | 32 | import com.sun.tools.javac.util.List; |
duke@1 | 33 | import com.sun.tools.javac.util.Pair; |
duke@1 | 34 | |
duke@1 | 35 | |
duke@1 | 36 | /** |
duke@1 | 37 | * Represents an annotation. |
duke@1 | 38 | * An annotation associates a value with each element of an annotation type. |
duke@1 | 39 | * Sure it ought to be called "Annotation", but that clashes with |
duke@1 | 40 | * java.lang.annotation.Annotation. |
duke@1 | 41 | * |
jjg@1359 | 42 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 43 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 44 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 45 | * deletion without notice.</b> |
jjg@1359 | 46 | * |
duke@1 | 47 | * @author Scott Seligman |
duke@1 | 48 | * @since 1.5 |
duke@1 | 49 | */ |
duke@1 | 50 | |
duke@1 | 51 | public class AnnotationDescImpl implements AnnotationDesc { |
duke@1 | 52 | |
duke@1 | 53 | private final DocEnv env; |
duke@1 | 54 | private final Attribute.Compound annotation; |
duke@1 | 55 | |
duke@1 | 56 | |
duke@1 | 57 | AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) { |
duke@1 | 58 | this.env = env; |
duke@1 | 59 | this.annotation = annotation; |
duke@1 | 60 | } |
duke@1 | 61 | |
duke@1 | 62 | /** |
duke@1 | 63 | * Returns the annotation type of this annotation. |
duke@1 | 64 | */ |
duke@1 | 65 | public AnnotationTypeDoc annotationType() { |
duke@1 | 66 | ClassSymbol atsym = (ClassSymbol)annotation.type.tsym; |
jjg@406 | 67 | if (annotation.type.isErroneous()) { |
jjg@406 | 68 | env.warning(null, "javadoc.class_not_found", annotation.type.toString()); |
jjg@406 | 69 | return new AnnotationTypeDocImpl(env, atsym); |
jjg@406 | 70 | } else { |
jjg@406 | 71 | return (AnnotationTypeDoc)env.getClassDoc(atsym); |
jjg@406 | 72 | } |
duke@1 | 73 | } |
duke@1 | 74 | |
duke@1 | 75 | /** |
duke@1 | 76 | * Returns this annotation's elements and their values. |
duke@1 | 77 | * Only those explicitly present in the annotation are |
duke@1 | 78 | * included, not those assuming their default values. |
duke@1 | 79 | * Returns an empty array if there are none. |
duke@1 | 80 | */ |
duke@1 | 81 | public ElementValuePair[] elementValues() { |
duke@1 | 82 | List<Pair<MethodSymbol,Attribute>> vals = annotation.values; |
duke@1 | 83 | ElementValuePair res[] = new ElementValuePair[vals.length()]; |
duke@1 | 84 | int i = 0; |
duke@1 | 85 | for (Pair<MethodSymbol,Attribute> val : vals) { |
duke@1 | 86 | res[i++] = new ElementValuePairImpl(env, val.fst, val.snd); |
duke@1 | 87 | } |
duke@1 | 88 | return res; |
duke@1 | 89 | } |
duke@1 | 90 | |
duke@1 | 91 | /** |
duke@1 | 92 | * Returns a string representation of this annotation. |
duke@1 | 93 | * String is of one of the forms: |
duke@1 | 94 | * @com.example.foo(name1=val1, name2=val2) |
duke@1 | 95 | * @com.example.foo(val) |
duke@1 | 96 | * @com.example.foo |
duke@1 | 97 | * Omit parens for marker annotations, and omit "value=" when allowed. |
duke@1 | 98 | */ |
jjg@910 | 99 | @Override |
duke@1 | 100 | public String toString() { |
jjg@910 | 101 | StringBuilder sb = new StringBuilder("@"); |
duke@1 | 102 | sb.append(annotation.type.tsym); |
duke@1 | 103 | |
duke@1 | 104 | ElementValuePair vals[] = elementValues(); |
duke@1 | 105 | if (vals.length > 0) { // omit parens for marker annotation |
duke@1 | 106 | sb.append('('); |
duke@1 | 107 | boolean first = true; |
duke@1 | 108 | for (ElementValuePair val : vals) { |
duke@1 | 109 | if (!first) { |
duke@1 | 110 | sb.append(", "); |
duke@1 | 111 | } |
duke@1 | 112 | first = false; |
duke@1 | 113 | |
duke@1 | 114 | String name = val.element().name(); |
duke@1 | 115 | if (vals.length == 1 && name.equals("value")) { |
duke@1 | 116 | sb.append(val.value()); |
duke@1 | 117 | } else { |
duke@1 | 118 | sb.append(val); |
duke@1 | 119 | } |
duke@1 | 120 | } |
duke@1 | 121 | sb.append(')'); |
duke@1 | 122 | } |
duke@1 | 123 | return sb.toString(); |
duke@1 | 124 | } |
duke@1 | 125 | |
duke@1 | 126 | |
duke@1 | 127 | /** |
duke@1 | 128 | * Represents an association between an annotation type element |
duke@1 | 129 | * and one of its values. |
duke@1 | 130 | */ |
duke@1 | 131 | public static class ElementValuePairImpl implements ElementValuePair { |
duke@1 | 132 | |
duke@1 | 133 | private final DocEnv env; |
duke@1 | 134 | private final MethodSymbol meth; |
duke@1 | 135 | private final Attribute value; |
duke@1 | 136 | |
duke@1 | 137 | ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) { |
duke@1 | 138 | this.env = env; |
duke@1 | 139 | this.meth = meth; |
duke@1 | 140 | this.value = value; |
duke@1 | 141 | } |
duke@1 | 142 | |
duke@1 | 143 | /** |
duke@1 | 144 | * Returns the annotation type element. |
duke@1 | 145 | */ |
duke@1 | 146 | public AnnotationTypeElementDoc element() { |
duke@1 | 147 | return env.getAnnotationTypeElementDoc(meth); |
duke@1 | 148 | } |
duke@1 | 149 | |
duke@1 | 150 | /** |
duke@1 | 151 | * Returns the value associated with the annotation type element. |
duke@1 | 152 | */ |
duke@1 | 153 | public AnnotationValue value() { |
duke@1 | 154 | return new AnnotationValueImpl(env, value); |
duke@1 | 155 | } |
duke@1 | 156 | |
duke@1 | 157 | /** |
duke@1 | 158 | * Returns a string representation of this pair |
duke@1 | 159 | * of the form "name=value". |
duke@1 | 160 | */ |
jjg@910 | 161 | @Override |
duke@1 | 162 | public String toString() { |
duke@1 | 163 | return meth.name + "=" + value(); |
duke@1 | 164 | } |
duke@1 | 165 | } |
duke@1 | 166 | } |