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

Thu, 25 Oct 2012 11:09:36 -0700

author
jjg
date
Thu, 25 Oct 2012 11:09:36 -0700
changeset 1374
c002fdee76fd
parent 1359
25e14ad23cef
child 1755
ddb4a2bfcd82
permissions
-rw-r--r--

7200915: convert TypeTags from a series of small ints to an enum
Reviewed-by: jjg, mcimadamore
Contributed-by: vicente.romero@oracle.com

duke@1 1 /*
jfranck@1313 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
jjg@1374 33 import static com.sun.tools.javac.code.TypeTag.BOOLEAN;
duke@1 34
duke@1 35 /**
duke@1 36 * Represents a value of an annotation type element.
duke@1 37 *
jjg@1359 38 * <p><b>This is NOT part of any supported API.
jjg@1359 39 * If you write code that depends on this, you do so at your own risk.
jjg@1359 40 * This code and its internal interfaces are subject to change or
jjg@1359 41 * deletion without notice.</b>
jjg@1359 42 *
duke@1 43 * @author Scott Seligman
duke@1 44 * @since 1.5
duke@1 45 */
duke@1 46
duke@1 47 public class AnnotationValueImpl implements AnnotationValue {
duke@1 48
duke@1 49 private final DocEnv env;
duke@1 50 private final Attribute attr;
duke@1 51
duke@1 52
duke@1 53 AnnotationValueImpl(DocEnv env, Attribute attr) {
duke@1 54 this.env = env;
duke@1 55 this.attr = attr;
duke@1 56 }
duke@1 57
duke@1 58 /**
duke@1 59 * Returns the value.
duke@1 60 * The type of the returned object is one of the following:
duke@1 61 * <ul><li> a wrapper class for a primitive type
duke@1 62 * <li> <code>String</code>
duke@1 63 * <li> <code>Type</code> (representing a class literal)
duke@1 64 * <li> <code>FieldDoc</code> (representing an enum constant)
duke@1 65 * <li> <code>AnnotationDesc</code>
duke@1 66 * <li> <code>AnnotationValue[]</code>
duke@1 67 * </ul>
duke@1 68 */
duke@1 69 public Object value() {
duke@1 70 ValueVisitor vv = new ValueVisitor();
duke@1 71 attr.accept(vv);
duke@1 72 return vv.value;
duke@1 73 }
duke@1 74
duke@1 75 private class ValueVisitor implements Attribute.Visitor {
duke@1 76 public Object value;
duke@1 77
duke@1 78 public void visitConstant(Attribute.Constant c) {
jjg@1374 79 if (c.type.hasTag(BOOLEAN)) {
duke@1 80 // javac represents false and true as integers 0 and 1
duke@1 81 value = Boolean.valueOf(
duke@1 82 ((Integer)c.value).intValue() != 0);
duke@1 83 } else {
duke@1 84 value = c.value;
duke@1 85 }
duke@1 86 }
duke@1 87
duke@1 88 public void visitClass(Attribute.Class c) {
duke@1 89 value = TypeMaker.getType(env,
jfranck@1313 90 env.types.erasure(c.classType));
duke@1 91 }
duke@1 92
duke@1 93 public void visitEnum(Attribute.Enum e) {
duke@1 94 value = env.getFieldDoc(e.value);
duke@1 95 }
duke@1 96
duke@1 97 public void visitCompound(Attribute.Compound c) {
duke@1 98 value = new AnnotationDescImpl(env, c);
duke@1 99 }
duke@1 100
duke@1 101 public void visitArray(Attribute.Array a) {
duke@1 102 AnnotationValue vals[] = new AnnotationValue[a.values.length];
duke@1 103 for (int i = 0; i < vals.length; i++) {
duke@1 104 vals[i] = new AnnotationValueImpl(env, a.values[i]);
duke@1 105 }
duke@1 106 value = vals;
duke@1 107 }
duke@1 108
duke@1 109 public void visitError(Attribute.Error e) {
duke@1 110 value = "<error>";
duke@1 111 }
duke@1 112 }
duke@1 113
duke@1 114 /**
duke@1 115 * Returns a string representation of the value.
duke@1 116 *
duke@1 117 * @return the text of a Java language annotation value expression
duke@1 118 * whose value is the value of this annotation type element.
duke@1 119 */
jjg@910 120 @Override
duke@1 121 public String toString() {
duke@1 122 ToStringVisitor tv = new ToStringVisitor();
duke@1 123 attr.accept(tv);
duke@1 124 return tv.toString();
duke@1 125 }
duke@1 126
duke@1 127 private class ToStringVisitor implements Attribute.Visitor {
jjg@910 128 private final StringBuilder sb = new StringBuilder();
duke@1 129
jjg@910 130 @Override
duke@1 131 public String toString() {
duke@1 132 return sb.toString();
duke@1 133 }
duke@1 134
duke@1 135 public void visitConstant(Attribute.Constant c) {
jjg@1374 136 if (c.type.hasTag(BOOLEAN)) {
duke@1 137 // javac represents false and true as integers 0 and 1
duke@1 138 sb.append(((Integer)c.value).intValue() != 0);
duke@1 139 } else {
duke@1 140 sb.append(FieldDocImpl.constantValueExpression(c.value));
duke@1 141 }
duke@1 142 }
duke@1 143
duke@1 144 public void visitClass(Attribute.Class c) {
duke@1 145 sb.append(c);
duke@1 146 }
duke@1 147
duke@1 148 public void visitEnum(Attribute.Enum e) {
duke@1 149 sb.append(e);
duke@1 150 }
duke@1 151
duke@1 152 public void visitCompound(Attribute.Compound c) {
duke@1 153 sb.append(new AnnotationDescImpl(env, c));
duke@1 154 }
duke@1 155
duke@1 156 public void visitArray(Attribute.Array a) {
duke@1 157 // Omit braces from singleton.
duke@1 158 if (a.values.length != 1) sb.append('{');
duke@1 159
duke@1 160 boolean first = true;
duke@1 161 for (Attribute elem : a.values) {
duke@1 162 if (first) {
duke@1 163 first = false;
duke@1 164 } else {
duke@1 165 sb.append(", ");
duke@1 166 }
duke@1 167 elem.accept(this);
duke@1 168 }
duke@1 169 // Omit braces from singleton.
duke@1 170 if (a.values.length != 1) sb.append('}');
duke@1 171 }
duke@1 172
duke@1 173 public void visitError(Attribute.Error e) {
duke@1 174 sb.append("<error>");
duke@1 175 }
duke@1 176 }
duke@1 177 }

mercurial