duke@1: /*
jfranck@1313: * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.javadoc;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
duke@1: import com.sun.tools.javac.code.Attribute;
duke@1: import com.sun.tools.javac.code.Symbol.*;
duke@1:
jjg@1374: import static com.sun.tools.javac.code.TypeTag.BOOLEAN;
duke@1:
duke@1: /**
duke@1: * Represents a value of an annotation type element.
duke@1: *
jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
jjg@1359: *
duke@1: * @author Scott Seligman
duke@1: * @since 1.5
duke@1: */
duke@1:
duke@1: public class AnnotationValueImpl implements AnnotationValue {
duke@1:
duke@1: private final DocEnv env;
duke@1: private final Attribute attr;
duke@1:
duke@1:
duke@1: AnnotationValueImpl(DocEnv env, Attribute attr) {
duke@1: this.env = env;
duke@1: this.attr = attr;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Returns the value.
duke@1: * The type of the returned object is one of the following:
duke@1: *
- a wrapper class for a primitive type
duke@1: *
-
String
duke@1: * -
Type
(representing a class literal)
duke@1: * -
FieldDoc
(representing an enum constant)
duke@1: * -
AnnotationDesc
duke@1: * -
AnnotationValue[]
duke@1: *
duke@1: */
duke@1: public Object value() {
duke@1: ValueVisitor vv = new ValueVisitor();
duke@1: attr.accept(vv);
duke@1: return vv.value;
duke@1: }
duke@1:
duke@1: private class ValueVisitor implements Attribute.Visitor {
duke@1: public Object value;
duke@1:
duke@1: public void visitConstant(Attribute.Constant c) {
jjg@1374: if (c.type.hasTag(BOOLEAN)) {
duke@1: // javac represents false and true as integers 0 and 1
duke@1: value = Boolean.valueOf(
duke@1: ((Integer)c.value).intValue() != 0);
duke@1: } else {
duke@1: value = c.value;
duke@1: }
duke@1: }
duke@1:
duke@1: public void visitClass(Attribute.Class c) {
duke@1: value = TypeMaker.getType(env,
jfranck@1313: env.types.erasure(c.classType));
duke@1: }
duke@1:
duke@1: public void visitEnum(Attribute.Enum e) {
duke@1: value = env.getFieldDoc(e.value);
duke@1: }
duke@1:
duke@1: public void visitCompound(Attribute.Compound c) {
duke@1: value = new AnnotationDescImpl(env, c);
duke@1: }
duke@1:
duke@1: public void visitArray(Attribute.Array a) {
duke@1: AnnotationValue vals[] = new AnnotationValue[a.values.length];
duke@1: for (int i = 0; i < vals.length; i++) {
duke@1: vals[i] = new AnnotationValueImpl(env, a.values[i]);
duke@1: }
duke@1: value = vals;
duke@1: }
duke@1:
duke@1: public void visitError(Attribute.Error e) {
duke@1: value = "";
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Returns a string representation of the value.
duke@1: *
duke@1: * @return the text of a Java language annotation value expression
duke@1: * whose value is the value of this annotation type element.
duke@1: */
jjg@910: @Override
duke@1: public String toString() {
duke@1: ToStringVisitor tv = new ToStringVisitor();
duke@1: attr.accept(tv);
duke@1: return tv.toString();
duke@1: }
duke@1:
duke@1: private class ToStringVisitor implements Attribute.Visitor {
jjg@910: private final StringBuilder sb = new StringBuilder();
duke@1:
jjg@910: @Override
duke@1: public String toString() {
duke@1: return sb.toString();
duke@1: }
duke@1:
duke@1: public void visitConstant(Attribute.Constant c) {
jjg@1374: if (c.type.hasTag(BOOLEAN)) {
duke@1: // javac represents false and true as integers 0 and 1
duke@1: sb.append(((Integer)c.value).intValue() != 0);
duke@1: } else {
duke@1: sb.append(FieldDocImpl.constantValueExpression(c.value));
duke@1: }
duke@1: }
duke@1:
duke@1: public void visitClass(Attribute.Class c) {
duke@1: sb.append(c);
duke@1: }
duke@1:
duke@1: public void visitEnum(Attribute.Enum e) {
duke@1: sb.append(e);
duke@1: }
duke@1:
duke@1: public void visitCompound(Attribute.Compound c) {
duke@1: sb.append(new AnnotationDescImpl(env, c));
duke@1: }
duke@1:
duke@1: public void visitArray(Attribute.Array a) {
duke@1: // Omit braces from singleton.
duke@1: if (a.values.length != 1) sb.append('{');
duke@1:
duke@1: boolean first = true;
duke@1: for (Attribute elem : a.values) {
duke@1: if (first) {
duke@1: first = false;
duke@1: } else {
duke@1: sb.append(", ");
duke@1: }
duke@1: elem.accept(this);
duke@1: }
duke@1: // Omit braces from singleton.
duke@1: if (a.values.length != 1) sb.append('}');
duke@1: }
duke@1:
duke@1: public void visitError(Attribute.Error e) {
duke@1: sb.append("");
duke@1: }
duke@1: }
duke@1: }