Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/ParameterImpl.java@998b10c43157 (annotated)
src/share/classes/com/sun/tools/javadoc/ParameterImpl.java
Tue, 24 Dec 2013 09:17:37 -0800
- author
- ksrini
- date
- Tue, 24 Dec 2013 09:17:37 -0800
- changeset 2227
- 998b10c43157
- parent 1464
- f72c9c5aeaef
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com
| duke@1 | 1 | /* |
| jjg@1357 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. 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 |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle 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 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * 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 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * ParameterImpl information. |
| duke@1 | 35 | * This includes a parameter type and parameter name. |
| duke@1 | 36 | * |
| jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 40 | * deletion without notice.</b> |
| jjg@1359 | 41 | * |
| duke@1 | 42 | * @author Kaiyang Liu (original) |
| duke@1 | 43 | * @author Robert Field (rewrite) |
| duke@1 | 44 | * @author Scott Seligman (generics, annotations) |
| duke@1 | 45 | */ |
| duke@1 | 46 | class ParameterImpl implements Parameter { |
| duke@1 | 47 | |
| duke@1 | 48 | private final DocEnv env; |
| duke@1 | 49 | private final VarSymbol sym; |
| duke@1 | 50 | private final com.sun.javadoc.Type type; |
| duke@1 | 51 | |
| duke@1 | 52 | /** |
| duke@1 | 53 | * Constructor of parameter info class. |
| duke@1 | 54 | */ |
| duke@1 | 55 | ParameterImpl(DocEnv env, VarSymbol sym) { |
| duke@1 | 56 | this.env = env; |
| duke@1 | 57 | this.sym = sym; |
| duke@1 | 58 | this.type = TypeMaker.getType(env, sym.type, false); |
| duke@1 | 59 | } |
| duke@1 | 60 | |
| duke@1 | 61 | /** |
| duke@1 | 62 | * Get the type of this parameter. |
| duke@1 | 63 | */ |
| duke@1 | 64 | public com.sun.javadoc.Type type() { |
| duke@1 | 65 | return type; |
| duke@1 | 66 | } |
| duke@1 | 67 | |
| duke@1 | 68 | /** |
| duke@1 | 69 | * Get local name of this parameter. |
| duke@1 | 70 | * For example if parameter is the short 'index', returns "index". |
| duke@1 | 71 | */ |
| duke@1 | 72 | public String name() { |
| duke@1 | 73 | return sym.toString(); |
| duke@1 | 74 | } |
| duke@1 | 75 | |
| duke@1 | 76 | /** |
| duke@1 | 77 | * Get type name of this parameter. |
| duke@1 | 78 | * For example if parameter is the short 'index', returns "short". |
| duke@1 | 79 | */ |
| duke@1 | 80 | public String typeName() { |
| duke@1 | 81 | return (type instanceof ClassDoc || type instanceof TypeVariable) |
| duke@1 | 82 | ? type.typeName() // omit formal type params or bounds |
| duke@1 | 83 | : type.toString(); |
| duke@1 | 84 | } |
| duke@1 | 85 | |
| duke@1 | 86 | /** |
| duke@1 | 87 | * Returns a string representation of the parameter. |
| duke@1 | 88 | * <p> |
| duke@1 | 89 | * For example if parameter is the short 'index', returns "short index". |
| duke@1 | 90 | * |
| duke@1 | 91 | * @return type name and parameter name of this parameter. |
| duke@1 | 92 | */ |
| duke@1 | 93 | public String toString() { |
| duke@1 | 94 | return typeName() + " " + sym; |
| duke@1 | 95 | } |
| duke@1 | 96 | |
| duke@1 | 97 | /** |
| duke@1 | 98 | * Get the annotations of this parameter. |
| duke@1 | 99 | * Return an empty array if there are none. |
| duke@1 | 100 | */ |
| duke@1 | 101 | public AnnotationDesc[] annotations() { |
| jfranck@1464 | 102 | AnnotationDesc res[] = new AnnotationDesc[sym.getRawAttributes().length()]; |
| duke@1 | 103 | int i = 0; |
| jfranck@1464 | 104 | for (Attribute.Compound a : sym.getRawAttributes()) { |
| duke@1 | 105 | res[i++] = new AnnotationDescImpl(env, a); |
| duke@1 | 106 | } |
| duke@1 | 107 | return res; |
| duke@1 | 108 | } |
| duke@1 | 109 | } |
