Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/ParameterImpl.java@829dea15ff99 (annotated)
src/share/classes/com/sun/tools/javadoc/ParameterImpl.java
Thu, 18 Sep 2008 18:39:44 -0700
- author
- jjg
- date
- Thu, 18 Sep 2008 18:39:44 -0700
- changeset 115
- 829dea15ff99
- parent 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
6744408: Extra ouput is appearing in stderr
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 1997-2005 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | |
| duke@1 | 30 | import com.sun.tools.javac.code.Attribute; |
| duke@1 | 31 | import com.sun.tools.javac.code.Symbol.VarSymbol; |
| duke@1 | 32 | import com.sun.tools.javac.code.Type; |
| duke@1 | 33 | |
| duke@1 | 34 | /** |
| duke@1 | 35 | * ParameterImpl information. |
| duke@1 | 36 | * This includes a parameter type and parameter name. |
| duke@1 | 37 | * |
| duke@1 | 38 | * @author Kaiyang Liu (original) |
| duke@1 | 39 | * @author Robert Field (rewrite) |
| duke@1 | 40 | * @author Scott Seligman (generics, annotations) |
| duke@1 | 41 | */ |
| duke@1 | 42 | class ParameterImpl implements Parameter { |
| duke@1 | 43 | |
| duke@1 | 44 | private final DocEnv env; |
| duke@1 | 45 | private final VarSymbol sym; |
| duke@1 | 46 | private final com.sun.javadoc.Type type; |
| duke@1 | 47 | |
| duke@1 | 48 | /** |
| duke@1 | 49 | * Constructor of parameter info class. |
| duke@1 | 50 | */ |
| duke@1 | 51 | ParameterImpl(DocEnv env, VarSymbol sym) { |
| duke@1 | 52 | this.env = env; |
| duke@1 | 53 | this.sym = sym; |
| duke@1 | 54 | this.type = TypeMaker.getType(env, sym.type, false); |
| duke@1 | 55 | } |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * Get the type of this parameter. |
| duke@1 | 59 | */ |
| duke@1 | 60 | public com.sun.javadoc.Type type() { |
| duke@1 | 61 | return type; |
| duke@1 | 62 | } |
| duke@1 | 63 | |
| duke@1 | 64 | /** |
| duke@1 | 65 | * Get local name of this parameter. |
| duke@1 | 66 | * For example if parameter is the short 'index', returns "index". |
| duke@1 | 67 | */ |
| duke@1 | 68 | public String name() { |
| duke@1 | 69 | return sym.toString(); |
| duke@1 | 70 | } |
| duke@1 | 71 | |
| duke@1 | 72 | /** |
| duke@1 | 73 | * Get type name of this parameter. |
| duke@1 | 74 | * For example if parameter is the short 'index', returns "short". |
| duke@1 | 75 | */ |
| duke@1 | 76 | public String typeName() { |
| duke@1 | 77 | return (type instanceof ClassDoc || type instanceof TypeVariable) |
| duke@1 | 78 | ? type.typeName() // omit formal type params or bounds |
| duke@1 | 79 | : type.toString(); |
| duke@1 | 80 | } |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| duke@1 | 83 | * Returns a string representation of the parameter. |
| duke@1 | 84 | * <p> |
| duke@1 | 85 | * For example if parameter is the short 'index', returns "short index". |
| duke@1 | 86 | * |
| duke@1 | 87 | * @return type name and parameter name of this parameter. |
| duke@1 | 88 | */ |
| duke@1 | 89 | public String toString() { |
| duke@1 | 90 | return typeName() + " " + sym; |
| duke@1 | 91 | } |
| duke@1 | 92 | |
| duke@1 | 93 | /** |
| duke@1 | 94 | * Get the annotations of this parameter. |
| duke@1 | 95 | * Return an empty array if there are none. |
| duke@1 | 96 | */ |
| duke@1 | 97 | public AnnotationDesc[] annotations() { |
| duke@1 | 98 | AnnotationDesc res[] = new AnnotationDesc[sym.getAnnotationMirrors().length()]; |
| duke@1 | 99 | int i = 0; |
| duke@1 | 100 | for (Attribute.Compound a : sym.getAnnotationMirrors()) { |
| duke@1 | 101 | res[i++] = new AnnotationDescImpl(env, a); |
| duke@1 | 102 | } |
| duke@1 | 103 | return res; |
| duke@1 | 104 | } |
| duke@1 | 105 | } |
