Thu, 15 Nov 2012 09:18:36 -0800
8000800: javadoc uses static non-final fields
Reviewed-by: bpatel
1 /*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.tools.javadoc;
28 import com.sun.javadoc.*;
30 import com.sun.tools.javac.code.Attribute;
31 import com.sun.tools.javac.code.Symbol.VarSymbol;
33 /**
34 * ParameterImpl information.
35 * This includes a parameter type and parameter name.
36 *
37 * <p><b>This is NOT part of any supported API.
38 * If you write code that depends on this, you do so at your own risk.
39 * This code and its internal interfaces are subject to change or
40 * deletion without notice.</b>
41 *
42 * @author Kaiyang Liu (original)
43 * @author Robert Field (rewrite)
44 * @author Scott Seligman (generics, annotations)
45 */
46 class ParameterImpl implements Parameter {
48 private final DocEnv env;
49 private final VarSymbol sym;
50 private final com.sun.javadoc.Type type;
52 /**
53 * Constructor of parameter info class.
54 */
55 ParameterImpl(DocEnv env, VarSymbol sym) {
56 this.env = env;
57 this.sym = sym;
58 this.type = TypeMaker.getType(env, sym.type, false);
59 }
61 /**
62 * Get the type of this parameter.
63 */
64 public com.sun.javadoc.Type type() {
65 return type;
66 }
68 /**
69 * Get local name of this parameter.
70 * For example if parameter is the short 'index', returns "index".
71 */
72 public String name() {
73 return sym.toString();
74 }
76 /**
77 * Get type name of this parameter.
78 * For example if parameter is the short 'index', returns "short".
79 */
80 public String typeName() {
81 return (type instanceof ClassDoc || type instanceof TypeVariable)
82 ? type.typeName() // omit formal type params or bounds
83 : type.toString();
84 }
86 /**
87 * Returns a string representation of the parameter.
88 * <p>
89 * For example if parameter is the short 'index', returns "short index".
90 *
91 * @return type name and parameter name of this parameter.
92 */
93 public String toString() {
94 return typeName() + " " + sym;
95 }
97 /**
98 * Get the annotations of this parameter.
99 * Return an empty array if there are none.
100 */
101 public AnnotationDesc[] annotations() {
102 AnnotationDesc res[] = new AnnotationDesc[sym.getAnnotationMirrors().length()];
103 int i = 0;
104 for (Attribute.Compound a : sym.getAnnotationMirrors()) {
105 res[i++] = new AnnotationDescImpl(env, a);
106 }
107 return res;
108 }
109 }