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