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 */
25
26package com.sun.tools.javadoc.main;
27
28import com.sun.javadoc.*;
29
30import com.sun.tools.javac.code.Attribute;
31import com.sun.tools.javac.code.Symbol.VarSymbol;
32
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@Deprecated
47class ParameterImpl implements Parameter {
48
49    private final DocEnv env;
50    private final VarSymbol sym;
51    private final com.sun.javadoc.Type type;
52
53    /**
54     * Constructor of parameter info class.
55     */
56    ParameterImpl(DocEnv env, VarSymbol sym) {
57        this.env = env;
58        this.sym = sym;
59        this.type = TypeMaker.getType(env, sym.type, false);
60    }
61
62    /**
63     * Get the type of this parameter.
64     */
65    public com.sun.javadoc.Type type() {
66        return type;
67    }
68
69    /**
70     * Get local name of this parameter.
71     * For example if parameter is the short 'index', returns "index".
72     */
73    public String name() {
74        return sym.toString();
75    }
76
77    /**
78     * Get type name of this parameter.
79     * For example if parameter is the short 'index', returns "short".
80     */
81    public String typeName() {
82        return (type instanceof ClassDoc || type instanceof TypeVariable)
83                ? type.typeName()       // omit formal type params or bounds
84                : type.toString();
85    }
86
87    /**
88     * Returns a string representation of the parameter.
89     * <p>
90     * For example if parameter is the short 'index', returns "short index".
91     *
92     * @return type name and parameter name of this parameter.
93     */
94    public String toString() {
95        return typeName() + " " + sym;
96    }
97
98    /**
99     * Get the annotations of this parameter.
100     * Return an empty array if there are none.
101     */
102    public AnnotationDesc[] annotations() {
103        AnnotationDesc res[] = new AnnotationDesc[sym.getRawAttributes().length()];
104        int i = 0;
105        for (Attribute.Compound a : sym.getRawAttributes()) {
106            res[i++] = new AnnotationDescImpl(env, a);
107        }
108        return res;
109    }
110}
111