Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/ConstructorDocImpl.java@b0909f992710 (annotated)
src/share/classes/com/sun/tools/javadoc/ConstructorDocImpl.java
Thu, 30 Jun 2011 14:33:45 -0700
- author
- ksrini
- date
- Thu, 30 Jun 2011 14:33:45 -0700
- changeset 1051
- b0909f992710
- parent 554
- 9d9f26857129
- child 1359
- 25e14ad23cef
- permissions
- -rw-r--r--
7059905: (javadoc) promote method visibility for netbeans usage
Reviewed-by: jjg, bpatel
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 1997, 2006, 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.Symbol.ClassSymbol; |
| duke@1 | 31 | import com.sun.tools.javac.code.Symbol.MethodSymbol; |
| duke@1 | 32 | import com.sun.tools.javac.tree.JCTree.JCMethodDecl; |
| duke@1 | 33 | import com.sun.tools.javac.util.Position; |
| duke@1 | 34 | |
| duke@1 | 35 | /** |
| duke@1 | 36 | * Represents a constructor of a java class. |
| duke@1 | 37 | * |
| duke@1 | 38 | * @since 1.2 |
| duke@1 | 39 | * @author Robert Field |
| duke@1 | 40 | * @author Neal Gafter (rewrite) |
| duke@1 | 41 | */ |
| duke@1 | 42 | |
| duke@1 | 43 | public class ConstructorDocImpl |
| duke@1 | 44 | extends ExecutableMemberDocImpl implements ConstructorDoc { |
| duke@1 | 45 | |
| duke@1 | 46 | /** |
| duke@1 | 47 | * constructor. |
| duke@1 | 48 | */ |
| duke@1 | 49 | public ConstructorDocImpl(DocEnv env, MethodSymbol sym) { |
| duke@1 | 50 | super(env, sym); |
| duke@1 | 51 | } |
| duke@1 | 52 | |
| duke@1 | 53 | /** |
| duke@1 | 54 | * constructor. |
| duke@1 | 55 | */ |
| duke@1 | 56 | public ConstructorDocImpl(DocEnv env, MethodSymbol sym, |
| duke@1 | 57 | String docComment, JCMethodDecl tree, Position.LineMap lineMap) { |
| duke@1 | 58 | super(env, sym, docComment, tree, lineMap); |
| duke@1 | 59 | } |
| duke@1 | 60 | |
| duke@1 | 61 | /** |
| duke@1 | 62 | * Return true if it is a constructor, which it is. |
| duke@1 | 63 | * |
| duke@1 | 64 | * @return true |
| duke@1 | 65 | */ |
| duke@1 | 66 | public boolean isConstructor() { |
| duke@1 | 67 | return true; |
| duke@1 | 68 | } |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Get the name. |
| duke@1 | 72 | * |
| duke@1 | 73 | * @return the name of the member qualified by class (but not package) |
| duke@1 | 74 | */ |
| duke@1 | 75 | public String name() { |
| duke@1 | 76 | ClassSymbol c = sym.enclClass(); |
| duke@1 | 77 | String n = c.name.toString(); |
| duke@1 | 78 | for (c = c.owner.enclClass(); c != null; c = c.owner.enclClass()) { |
| duke@1 | 79 | n = c.name.toString() + "." + n; |
| duke@1 | 80 | } |
| duke@1 | 81 | return n; |
| duke@1 | 82 | } |
| duke@1 | 83 | |
| duke@1 | 84 | /** |
| duke@1 | 85 | * Get the name. |
| duke@1 | 86 | * |
| duke@1 | 87 | * @return the qualified name of the member. |
| duke@1 | 88 | */ |
| duke@1 | 89 | public String qualifiedName() { |
| duke@1 | 90 | return sym.enclClass().getQualifiedName().toString(); |
| duke@1 | 91 | } |
| duke@1 | 92 | |
| duke@1 | 93 | /** |
| duke@1 | 94 | * Returns a string representation of this constructor. Includes the |
| duke@1 | 95 | * qualified signature and any type parameters. |
| duke@1 | 96 | * Type parameters precede the class name, as they do in the syntax |
| duke@1 | 97 | * for invoking constructors with explicit type parameters using "new". |
| duke@1 | 98 | * (This is unlike the syntax for invoking methods with explicit type |
| duke@1 | 99 | * parameters.) |
| duke@1 | 100 | */ |
| duke@1 | 101 | public String toString() { |
| duke@1 | 102 | return typeParametersString() + qualifiedName() + signature(); |
| duke@1 | 103 | } |
| duke@1 | 104 | } |
