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

Tue, 09 Oct 2012 19:10:00 -0700

author
jjg
date
Tue, 09 Oct 2012 19:10:00 -0700
changeset 1357
c75be5bc5283
parent 910
ebf7c13df6c0
child 1359
25e14ad23cef
permissions
-rw-r--r--

8000663: clean up langtools imports
Reviewed-by: darcy

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 *
duke@1 42 * @author Scott Seligman
duke@1 43 * @since 1.5
duke@1 44 */
duke@1 45
duke@1 46 public class AnnotationDescImpl implements AnnotationDesc {
duke@1 47
duke@1 48 private final DocEnv env;
duke@1 49 private final Attribute.Compound annotation;
duke@1 50
duke@1 51
duke@1 52 AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) {
duke@1 53 this.env = env;
duke@1 54 this.annotation = annotation;
duke@1 55 }
duke@1 56
duke@1 57 /**
duke@1 58 * Returns the annotation type of this annotation.
duke@1 59 */
duke@1 60 public AnnotationTypeDoc annotationType() {
duke@1 61 ClassSymbol atsym = (ClassSymbol)annotation.type.tsym;
jjg@406 62 if (annotation.type.isErroneous()) {
jjg@406 63 env.warning(null, "javadoc.class_not_found", annotation.type.toString());
jjg@406 64 return new AnnotationTypeDocImpl(env, atsym);
jjg@406 65 } else {
jjg@406 66 return (AnnotationTypeDoc)env.getClassDoc(atsym);
jjg@406 67 }
duke@1 68 }
duke@1 69
duke@1 70 /**
duke@1 71 * Returns this annotation's elements and their values.
duke@1 72 * Only those explicitly present in the annotation are
duke@1 73 * included, not those assuming their default values.
duke@1 74 * Returns an empty array if there are none.
duke@1 75 */
duke@1 76 public ElementValuePair[] elementValues() {
duke@1 77 List<Pair<MethodSymbol,Attribute>> vals = annotation.values;
duke@1 78 ElementValuePair res[] = new ElementValuePair[vals.length()];
duke@1 79 int i = 0;
duke@1 80 for (Pair<MethodSymbol,Attribute> val : vals) {
duke@1 81 res[i++] = new ElementValuePairImpl(env, val.fst, val.snd);
duke@1 82 }
duke@1 83 return res;
duke@1 84 }
duke@1 85
duke@1 86 /**
duke@1 87 * Returns a string representation of this annotation.
duke@1 88 * String is of one of the forms:
duke@1 89 * @com.example.foo(name1=val1, name2=val2)
duke@1 90 * @com.example.foo(val)
duke@1 91 * @com.example.foo
duke@1 92 * Omit parens for marker annotations, and omit "value=" when allowed.
duke@1 93 */
jjg@910 94 @Override
duke@1 95 public String toString() {
jjg@910 96 StringBuilder sb = new StringBuilder("@");
duke@1 97 sb.append(annotation.type.tsym);
duke@1 98
duke@1 99 ElementValuePair vals[] = elementValues();
duke@1 100 if (vals.length > 0) { // omit parens for marker annotation
duke@1 101 sb.append('(');
duke@1 102 boolean first = true;
duke@1 103 for (ElementValuePair val : vals) {
duke@1 104 if (!first) {
duke@1 105 sb.append(", ");
duke@1 106 }
duke@1 107 first = false;
duke@1 108
duke@1 109 String name = val.element().name();
duke@1 110 if (vals.length == 1 && name.equals("value")) {
duke@1 111 sb.append(val.value());
duke@1 112 } else {
duke@1 113 sb.append(val);
duke@1 114 }
duke@1 115 }
duke@1 116 sb.append(')');
duke@1 117 }
duke@1 118 return sb.toString();
duke@1 119 }
duke@1 120
duke@1 121
duke@1 122 /**
duke@1 123 * Represents an association between an annotation type element
duke@1 124 * and one of its values.
duke@1 125 */
duke@1 126 public static class ElementValuePairImpl implements ElementValuePair {
duke@1 127
duke@1 128 private final DocEnv env;
duke@1 129 private final MethodSymbol meth;
duke@1 130 private final Attribute value;
duke@1 131
duke@1 132 ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) {
duke@1 133 this.env = env;
duke@1 134 this.meth = meth;
duke@1 135 this.value = value;
duke@1 136 }
duke@1 137
duke@1 138 /**
duke@1 139 * Returns the annotation type element.
duke@1 140 */
duke@1 141 public AnnotationTypeElementDoc element() {
duke@1 142 return env.getAnnotationTypeElementDoc(meth);
duke@1 143 }
duke@1 144
duke@1 145 /**
duke@1 146 * Returns the value associated with the annotation type element.
duke@1 147 */
duke@1 148 public AnnotationValue value() {
duke@1 149 return new AnnotationValueImpl(env, value);
duke@1 150 }
duke@1 151
duke@1 152 /**
duke@1 153 * Returns a string representation of this pair
duke@1 154 * of the form "name=value".
duke@1 155 */
jjg@910 156 @Override
duke@1 157 public String toString() {
duke@1 158 return meth.name + "=" + value();
duke@1 159 }
duke@1 160 }
duke@1 161 }

mercurial