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