0N/A/*
553N/A * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.javadoc;
0N/A
0N/Aimport com.sun.javadoc.*;
0N/A
0N/Aimport com.sun.tools.javac.code.Attribute;
0N/Aimport com.sun.tools.javac.code.Symbol.VarSymbol;
0N/Aimport com.sun.tools.javac.code.Type;
0N/A
0N/A/**
0N/A * ParameterImpl information.
0N/A * This includes a parameter type and parameter name.
0N/A *
0N/A * @author Kaiyang Liu (original)
0N/A * @author Robert Field (rewrite)
0N/A * @author Scott Seligman (generics, annotations)
0N/A */
0N/Aclass ParameterImpl implements Parameter {
0N/A
0N/A private final DocEnv env;
0N/A private final VarSymbol sym;
0N/A private final com.sun.javadoc.Type type;
0N/A
0N/A /**
0N/A * Constructor of parameter info class.
0N/A */
0N/A ParameterImpl(DocEnv env, VarSymbol sym) {
0N/A this.env = env;
0N/A this.sym = sym;
0N/A this.type = TypeMaker.getType(env, sym.type, false);
0N/A }
0N/A
0N/A /**
0N/A * Get the type of this parameter.
0N/A */
0N/A public com.sun.javadoc.Type type() {
0N/A return type;
0N/A }
0N/A
0N/A /**
0N/A * Get local name of this parameter.
0N/A * For example if parameter is the short 'index', returns "index".
0N/A */
0N/A public String name() {
0N/A return sym.toString();
0N/A }
0N/A
0N/A /**
0N/A * Get type name of this parameter.
0N/A * For example if parameter is the short 'index', returns "short".
0N/A */
0N/A public String typeName() {
0N/A return (type instanceof ClassDoc || type instanceof TypeVariable)
0N/A ? type.typeName() // omit formal type params or bounds
0N/A : type.toString();
0N/A }
0N/A
0N/A /**
0N/A * Returns a string representation of the parameter.
0N/A * <p>
0N/A * For example if parameter is the short 'index', returns "short index".
0N/A *
0N/A * @return type name and parameter name of this parameter.
0N/A */
0N/A public String toString() {
0N/A return typeName() + " " + sym;
0N/A }
0N/A
0N/A /**
0N/A * Get the annotations of this parameter.
0N/A * Return an empty array if there are none.
0N/A */
0N/A public AnnotationDesc[] annotations() {
0N/A AnnotationDesc res[] = new AnnotationDesc[sym.getAnnotationMirrors().length()];
0N/A int i = 0;
0N/A for (Attribute.Compound a : sym.getAnnotationMirrors()) {
0N/A res[i++] = new AnnotationDescImpl(env, a);
0N/A }
0N/A return res;
0N/A }
0N/A}