• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/javadoc/AnnotationDescImpl.java@2eb010b6cb22 (annotated)

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

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 2227

998b10c43157

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.javadoc;
aoqi@0	27
aoqi@0	28	import com.sun.javadoc.*;
aoqi@0	29
aoqi@0	30	import com.sun.tools.javac.code.Attribute;
aoqi@0	31	import com.sun.tools.javac.code.Symbol.*;
aoqi@0	32	import com.sun.tools.javac.util.List;
aoqi@0	33	import com.sun.tools.javac.util.Pair;
aoqi@0	34
aoqi@0	35
aoqi@0	36	/**
aoqi@0	37	* Represents an annotation.
aoqi@0	38	* An annotation associates a value with each element of an annotation type.
aoqi@0	39	* Sure it ought to be called "Annotation", but that clashes with
aoqi@0	40	* java.lang.annotation.Annotation.
aoqi@0	41	*
aoqi@0	42	* <p><b>This is NOT part of any supported API.
aoqi@0	43	* If you write code that depends on this, you do so at your own risk.
aoqi@0	44	* This code and its internal interfaces are subject to change or
aoqi@0	45	* deletion without notice.</b>
aoqi@0	46	*
aoqi@0	47	* @author Scott Seligman
aoqi@0	48	* @since 1.5
aoqi@0	49	*/
aoqi@0	50
aoqi@0	51	public class AnnotationDescImpl implements AnnotationDesc {
aoqi@0	52
aoqi@0	53	private final DocEnv env;
aoqi@0	54	private final Attribute.Compound annotation;
aoqi@0	55
aoqi@0	56
aoqi@0	57	AnnotationDescImpl(DocEnv env, Attribute.Compound annotation) {
aoqi@0	58	this.env = env;
aoqi@0	59	this.annotation = annotation;
aoqi@0	60	}
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Returns the annotation type of this annotation.
aoqi@0	64	*/
aoqi@0	65	public AnnotationTypeDoc annotationType() {
aoqi@0	66	ClassSymbol atsym = (ClassSymbol)annotation.type.tsym;
aoqi@0	67	if (annotation.type.isErroneous()) {
aoqi@0	68	env.warning(null, "javadoc.class_not_found", annotation.type.toString());
aoqi@0	69	return new AnnotationTypeDocImpl(env, atsym);
aoqi@0	70	} else {
aoqi@0	71	return (AnnotationTypeDoc)env.getClassDoc(atsym);
aoqi@0	72	}
aoqi@0	73	}
aoqi@0	74
aoqi@0	75	/**
aoqi@0	76	* Returns this annotation's elements and their values.
aoqi@0	77	* Only those explicitly present in the annotation are
aoqi@0	78	* included, not those assuming their default values.
aoqi@0	79	* Returns an empty array if there are none.
aoqi@0	80	*/
aoqi@0	81	public ElementValuePair[] elementValues() {
aoqi@0	82	List<Pair<MethodSymbol,Attribute>> vals = annotation.values;
aoqi@0	83	ElementValuePair res[] = new ElementValuePair[vals.length()];
aoqi@0	84	int i = 0;
aoqi@0	85	for (Pair<MethodSymbol,Attribute> val : vals) {
aoqi@0	86	res[i++] = new ElementValuePairImpl(env, val.fst, val.snd);
aoqi@0	87	}
aoqi@0	88	return res;
aoqi@0	89	}
aoqi@0	90
aoqi@0	91	/**
aoqi@0	92	* Check for the synthesized bit on the annotation.
aoqi@0	93	*
aoqi@0	94	* @return true if the annotation is synthesized.
aoqi@0	95	*/
aoqi@0	96	public boolean isSynthesized() {
aoqi@0	97	return annotation.isSynthesized();
aoqi@0	98	}
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* Returns a string representation of this annotation.
aoqi@0	102	* String is of one of the forms:
aoqi@0	103	* @com.example.foo(name1=val1, name2=val2)
aoqi@0	104	* @com.example.foo(val)
aoqi@0	105	* @com.example.foo
aoqi@0	106	* Omit parens for marker annotations, and omit "value=" when allowed.
aoqi@0	107	*/
aoqi@0	108	@Override
aoqi@0	109	public String toString() {
aoqi@0	110	StringBuilder sb = new StringBuilder("@");
aoqi@0	111	sb.append(annotation.type.tsym);
aoqi@0	112
aoqi@0	113	ElementValuePair vals[] = elementValues();
aoqi@0	114	if (vals.length > 0) { // omit parens for marker annotation
aoqi@0	115	sb.append('(');
aoqi@0	116	boolean first = true;
aoqi@0	117	for (ElementValuePair val : vals) {
aoqi@0	118	if (!first) {
aoqi@0	119	sb.append(", ");
aoqi@0	120	}
aoqi@0	121	first = false;
aoqi@0	122
aoqi@0	123	String name = val.element().name();
aoqi@0	124	if (vals.length == 1 && name.equals("value")) {
aoqi@0	125	sb.append(val.value());
aoqi@0	126	} else {
aoqi@0	127	sb.append(val);
aoqi@0	128	}
aoqi@0	129	}
aoqi@0	130	sb.append(')');
aoqi@0	131	}
aoqi@0	132	return sb.toString();
aoqi@0	133	}
aoqi@0	134
aoqi@0	135
aoqi@0	136	/**
aoqi@0	137	* Represents an association between an annotation type element
aoqi@0	138	* and one of its values.
aoqi@0	139	*/
aoqi@0	140	public static class ElementValuePairImpl implements ElementValuePair {
aoqi@0	141
aoqi@0	142	private final DocEnv env;
aoqi@0	143	private final MethodSymbol meth;
aoqi@0	144	private final Attribute value;
aoqi@0	145
aoqi@0	146	ElementValuePairImpl(DocEnv env, MethodSymbol meth, Attribute value) {
aoqi@0	147	this.env = env;
aoqi@0	148	this.meth = meth;
aoqi@0	149	this.value = value;
aoqi@0	150	}
aoqi@0	151
aoqi@0	152	/**
aoqi@0	153	* Returns the annotation type element.
aoqi@0	154	*/
aoqi@0	155	public AnnotationTypeElementDoc element() {
aoqi@0	156	return env.getAnnotationTypeElementDoc(meth);
aoqi@0	157	}
aoqi@0	158
aoqi@0	159	/**
aoqi@0	160	* Returns the value associated with the annotation type element.
aoqi@0	161	*/
aoqi@0	162	public AnnotationValue value() {
aoqi@0	163	return new AnnotationValueImpl(env, value);
aoqi@0	164	}
aoqi@0	165
aoqi@0	166	/**
aoqi@0	167	* Returns a string representation of this pair
aoqi@0	168	* of the form "name=value".
aoqi@0	169	*/
aoqi@0	170	@Override
aoqi@0	171	public String toString() {
aoqi@0	172	return meth.name + "=" + value();
aoqi@0	173	}
aoqi@0	174	}
aoqi@0	175	}