duke@1: /* jjg@1357: * 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: import com.sun.tools.javac.util.List; duke@1: import com.sun.tools.javac.util.Pair; duke@1: duke@1: duke@1: /** duke@1: * Represents an annotation. duke@1: * An annotation associates a value with each element of an annotation type. duke@1: * Sure it ought to be called "Annotation", but that clashes with duke@1: * java.lang.annotation.Annotation. 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 AnnotationDescImpl implements AnnotationDesc { duke@1: duke@1: private final DocEnv env; duke@1: private final Attribute.Compound annotation; duke@1: duke@1: duke@1: AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) { duke@1: this.env = env; duke@1: this.annotation = annotation; duke@1: } duke@1: duke@1: /** duke@1: * Returns the annotation type of this annotation. duke@1: */ duke@1: public AnnotationTypeDoc annotationType() { duke@1: ClassSymbol atsym = (ClassSymbol)annotation.type.tsym; jjg@406: if (annotation.type.isErroneous()) { jjg@406: env.warning(null, "javadoc.class_not_found", annotation.type.toString()); jjg@406: return new AnnotationTypeDocImpl(env, atsym); jjg@406: } else { jjg@406: return (AnnotationTypeDoc)env.getClassDoc(atsym); jjg@406: } duke@1: } duke@1: duke@1: /** duke@1: * Returns this annotation's elements and their values. duke@1: * Only those explicitly present in the annotation are duke@1: * included, not those assuming their default values. duke@1: * Returns an empty array if there are none. duke@1: */ duke@1: public ElementValuePair[] elementValues() { duke@1: List> vals = annotation.values; duke@1: ElementValuePair res[] = new ElementValuePair[vals.length()]; duke@1: int i = 0; duke@1: for (Pair val : vals) { duke@1: res[i++] = new ElementValuePairImpl(env, val.fst, val.snd); duke@1: } duke@1: return res; duke@1: } duke@1: duke@1: /** bpatel@1477: * Check for the synthesized bit on the annotation. bpatel@1477: * bpatel@1477: * @return true if the annotation is synthesized. bpatel@1477: */ bpatel@1477: public boolean isSynthesized() { bpatel@1477: return annotation.isSynthesized(); bpatel@1477: } bpatel@1477: bpatel@1477: /** duke@1: * Returns a string representation of this annotation. duke@1: * String is of one of the forms: duke@1: * @com.example.foo(name1=val1, name2=val2) duke@1: * @com.example.foo(val) duke@1: * @com.example.foo duke@1: * Omit parens for marker annotations, and omit "value=" when allowed. duke@1: */ jjg@910: @Override duke@1: public String toString() { jjg@910: StringBuilder sb = new StringBuilder("@"); duke@1: sb.append(annotation.type.tsym); duke@1: duke@1: ElementValuePair vals[] = elementValues(); duke@1: if (vals.length > 0) { // omit parens for marker annotation duke@1: sb.append('('); duke@1: boolean first = true; duke@1: for (ElementValuePair val : vals) { duke@1: if (!first) { duke@1: sb.append(", "); duke@1: } duke@1: first = false; duke@1: duke@1: String name = val.element().name(); duke@1: if (vals.length == 1 && name.equals("value")) { duke@1: sb.append(val.value()); duke@1: } else { duke@1: sb.append(val); duke@1: } duke@1: } duke@1: sb.append(')'); duke@1: } duke@1: return sb.toString(); duke@1: } duke@1: duke@1: duke@1: /** duke@1: * Represents an association between an annotation type element duke@1: * and one of its values. duke@1: */ duke@1: public static class ElementValuePairImpl implements ElementValuePair { duke@1: duke@1: private final DocEnv env; duke@1: private final MethodSymbol meth; duke@1: private final Attribute value; duke@1: duke@1: ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) { duke@1: this.env = env; duke@1: this.meth = meth; duke@1: this.value = value; duke@1: } duke@1: duke@1: /** duke@1: * Returns the annotation type element. duke@1: */ duke@1: public AnnotationTypeElementDoc element() { duke@1: return env.getAnnotationTypeElementDoc(meth); duke@1: } duke@1: duke@1: /** duke@1: * Returns the value associated with the annotation type element. duke@1: */ duke@1: public AnnotationValue value() { duke@1: return new AnnotationValueImpl(env, value); duke@1: } duke@1: duke@1: /** duke@1: * Returns a string representation of this pair duke@1: * of the form "name=value". duke@1: */ jjg@910: @Override duke@1: public String toString() { duke@1: return meth.name + "=" + value(); duke@1: } duke@1: } duke@1: }