src/share/classes/com/sun/tools/javadoc/AnnotationDescImpl.java

Thu, 18 Sep 2008 18:39:44 -0700

author
jjg
date
Thu, 18 Sep 2008 18:39:44 -0700
changeset 115
829dea15ff99
parent 1
9a66ca7c79fa
child 406
071a4e36cd87
permissions
-rw-r--r--

6744408: Extra ouput is appearing in stderr
Reviewed-by: bpatel

duke@1 1 /*
duke@1 2 * Copyright 2003-2004 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javadoc;
duke@1 27
duke@1 28
duke@1 29 import com.sun.javadoc.*;
duke@1 30
duke@1 31 import com.sun.tools.javac.code.Attribute;
duke@1 32 import com.sun.tools.javac.code.Symbol.*;
duke@1 33 import com.sun.tools.javac.util.List;
duke@1 34 import com.sun.tools.javac.util.Pair;
duke@1 35
duke@1 36
duke@1 37 /**
duke@1 38 * Represents an annotation.
duke@1 39 * An annotation associates a value with each element of an annotation type.
duke@1 40 * Sure it ought to be called "Annotation", but that clashes with
duke@1 41 * java.lang.annotation.Annotation.
duke@1 42 *
duke@1 43 * @author Scott Seligman
duke@1 44 * @since 1.5
duke@1 45 */
duke@1 46
duke@1 47 public class AnnotationDescImpl implements AnnotationDesc {
duke@1 48
duke@1 49 private final DocEnv env;
duke@1 50 private final Attribute.Compound annotation;
duke@1 51
duke@1 52
duke@1 53 AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) {
duke@1 54 this.env = env;
duke@1 55 this.annotation = annotation;
duke@1 56 }
duke@1 57
duke@1 58 /**
duke@1 59 * Returns the annotation type of this annotation.
duke@1 60 */
duke@1 61 public AnnotationTypeDoc annotationType() {
duke@1 62 ClassSymbol atsym = (ClassSymbol)annotation.type.tsym;
duke@1 63 return (AnnotationTypeDoc)env.getClassDoc(atsym);
duke@1 64 }
duke@1 65
duke@1 66 /**
duke@1 67 * Returns this annotation's elements and their values.
duke@1 68 * Only those explicitly present in the annotation are
duke@1 69 * included, not those assuming their default values.
duke@1 70 * Returns an empty array if there are none.
duke@1 71 */
duke@1 72 public ElementValuePair[] elementValues() {
duke@1 73 List<Pair<MethodSymbol,Attribute>> vals = annotation.values;
duke@1 74 ElementValuePair res[] = new ElementValuePair[vals.length()];
duke@1 75 int i = 0;
duke@1 76 for (Pair<MethodSymbol,Attribute> val : vals) {
duke@1 77 res[i++] = new ElementValuePairImpl(env, val.fst, val.snd);
duke@1 78 }
duke@1 79 return res;
duke@1 80 }
duke@1 81
duke@1 82 /**
duke@1 83 * Returns a string representation of this annotation.
duke@1 84 * String is of one of the forms:
duke@1 85 * @com.example.foo(name1=val1, name2=val2)
duke@1 86 * @com.example.foo(val)
duke@1 87 * @com.example.foo
duke@1 88 * Omit parens for marker annotations, and omit "value=" when allowed.
duke@1 89 */
duke@1 90 public String toString() {
duke@1 91 StringBuffer sb = new StringBuffer("@");
duke@1 92 sb.append(annotation.type.tsym);
duke@1 93
duke@1 94 ElementValuePair vals[] = elementValues();
duke@1 95 if (vals.length > 0) { // omit parens for marker annotation
duke@1 96 sb.append('(');
duke@1 97 boolean first = true;
duke@1 98 for (ElementValuePair val : vals) {
duke@1 99 if (!first) {
duke@1 100 sb.append(", ");
duke@1 101 }
duke@1 102 first = false;
duke@1 103
duke@1 104 String name = val.element().name();
duke@1 105 if (vals.length == 1 && name.equals("value")) {
duke@1 106 sb.append(val.value());
duke@1 107 } else {
duke@1 108 sb.append(val);
duke@1 109 }
duke@1 110 }
duke@1 111 sb.append(')');
duke@1 112 }
duke@1 113 return sb.toString();
duke@1 114 }
duke@1 115
duke@1 116
duke@1 117 /**
duke@1 118 * Represents an association between an annotation type element
duke@1 119 * and one of its values.
duke@1 120 */
duke@1 121 public static class ElementValuePairImpl implements ElementValuePair {
duke@1 122
duke@1 123 private final DocEnv env;
duke@1 124 private final MethodSymbol meth;
duke@1 125 private final Attribute value;
duke@1 126
duke@1 127 ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) {
duke@1 128 this.env = env;
duke@1 129 this.meth = meth;
duke@1 130 this.value = value;
duke@1 131 }
duke@1 132
duke@1 133 /**
duke@1 134 * Returns the annotation type element.
duke@1 135 */
duke@1 136 public AnnotationTypeElementDoc element() {
duke@1 137 return env.getAnnotationTypeElementDoc(meth);
duke@1 138 }
duke@1 139
duke@1 140 /**
duke@1 141 * Returns the value associated with the annotation type element.
duke@1 142 */
duke@1 143 public AnnotationValue value() {
duke@1 144 return new AnnotationValueImpl(env, value);
duke@1 145 }
duke@1 146
duke@1 147 /**
duke@1 148 * Returns a string representation of this pair
duke@1 149 * of the form "name=value".
duke@1 150 */
duke@1 151 public String toString() {
duke@1 152 return meth.name + "=" + value();
duke@1 153 }
duke@1 154 }
duke@1 155 }

mercurial