aoqi@0: /* aoqi@0: * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.tools.javadoc; aoqi@0: aoqi@0: import com.sun.javadoc.*; aoqi@0: aoqi@0: import com.sun.tools.javac.code.Attribute; aoqi@0: import com.sun.tools.javac.code.Symbol.*; aoqi@0: import com.sun.tools.javac.util.List; aoqi@0: import com.sun.tools.javac.util.Pair; aoqi@0: aoqi@0: aoqi@0: /** aoqi@0: * Represents an annotation. aoqi@0: * An annotation associates a value with each element of an annotation type. aoqi@0: * Sure it ought to be called "Annotation", but that clashes with aoqi@0: * java.lang.annotation.Annotation. aoqi@0: * aoqi@0: *

This is NOT part of any supported API. aoqi@0: * If you write code that depends on this, you do so at your own risk. aoqi@0: * This code and its internal interfaces are subject to change or aoqi@0: * deletion without notice. aoqi@0: * aoqi@0: * @author Scott Seligman aoqi@0: * @since 1.5 aoqi@0: */ aoqi@0: aoqi@0: public class AnnotationDescImpl implements AnnotationDesc { aoqi@0: aoqi@0: private final DocEnv env; aoqi@0: private final Attribute.Compound annotation; aoqi@0: aoqi@0: aoqi@0: AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) { aoqi@0: this.env = env; aoqi@0: this.annotation = annotation; aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Returns the annotation type of this annotation. aoqi@0: */ aoqi@0: public AnnotationTypeDoc annotationType() { aoqi@0: ClassSymbol atsym = (ClassSymbol)annotation.type.tsym; aoqi@0: if (annotation.type.isErroneous()) { aoqi@0: env.warning(null, "javadoc.class_not_found", annotation.type.toString()); aoqi@0: return new AnnotationTypeDocImpl(env, atsym); aoqi@0: } else { aoqi@0: return (AnnotationTypeDoc)env.getClassDoc(atsym); aoqi@0: } aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Returns this annotation's elements and their values. aoqi@0: * Only those explicitly present in the annotation are aoqi@0: * included, not those assuming their default values. aoqi@0: * Returns an empty array if there are none. aoqi@0: */ aoqi@0: public ElementValuePair[] elementValues() { aoqi@0: List> vals = annotation.values; aoqi@0: ElementValuePair res[] = new ElementValuePair[vals.length()]; aoqi@0: int i = 0; aoqi@0: for (Pair val : vals) { aoqi@0: res[i++] = new ElementValuePairImpl(env, val.fst, val.snd); aoqi@0: } aoqi@0: return res; aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Check for the synthesized bit on the annotation. aoqi@0: * aoqi@0: * @return true if the annotation is synthesized. aoqi@0: */ aoqi@0: public boolean isSynthesized() { aoqi@0: return annotation.isSynthesized(); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Returns a string representation of this annotation. aoqi@0: * String is of one of the forms: aoqi@0: * @com.example.foo(name1=val1, name2=val2) aoqi@0: * @com.example.foo(val) aoqi@0: * @com.example.foo aoqi@0: * Omit parens for marker annotations, and omit "value=" when allowed. aoqi@0: */ aoqi@0: @Override aoqi@0: public String toString() { aoqi@0: StringBuilder sb = new StringBuilder("@"); aoqi@0: sb.append(annotation.type.tsym); aoqi@0: aoqi@0: ElementValuePair vals[] = elementValues(); aoqi@0: if (vals.length > 0) { // omit parens for marker annotation aoqi@0: sb.append('('); aoqi@0: boolean first = true; aoqi@0: for (ElementValuePair val : vals) { aoqi@0: if (!first) { aoqi@0: sb.append(", "); aoqi@0: } aoqi@0: first = false; aoqi@0: aoqi@0: String name = val.element().name(); aoqi@0: if (vals.length == 1 && name.equals("value")) { aoqi@0: sb.append(val.value()); aoqi@0: } else { aoqi@0: sb.append(val); aoqi@0: } aoqi@0: } aoqi@0: sb.append(')'); aoqi@0: } aoqi@0: return sb.toString(); aoqi@0: } aoqi@0: aoqi@0: aoqi@0: /** aoqi@0: * Represents an association between an annotation type element aoqi@0: * and one of its values. aoqi@0: */ aoqi@0: public static class ElementValuePairImpl implements ElementValuePair { aoqi@0: aoqi@0: private final DocEnv env; aoqi@0: private final MethodSymbol meth; aoqi@0: private final Attribute value; aoqi@0: aoqi@0: ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) { aoqi@0: this.env = env; aoqi@0: this.meth = meth; aoqi@0: this.value = value; aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Returns the annotation type element. aoqi@0: */ aoqi@0: public AnnotationTypeElementDoc element() { aoqi@0: return env.getAnnotationTypeElementDoc(meth); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Returns the value associated with the annotation type element. aoqi@0: */ aoqi@0: public AnnotationValue value() { aoqi@0: return new AnnotationValueImpl(env, value); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Returns a string representation of this pair aoqi@0: * of the form "name=value". aoqi@0: */ aoqi@0: @Override aoqi@0: public String toString() { aoqi@0: return meth.name + "=" + value(); aoqi@0: } aoqi@0: } aoqi@0: }