Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/ConstructorDocImpl.java@fdf30b225e1c (annotated)
src/share/classes/com/sun/tools/javadoc/ConstructorDocImpl.java
Mon, 25 Mar 2013 16:55:14 -0700
- author
- mfang
- date
- Mon, 25 Mar 2013 16:55:14 -0700
- changeset 1658
- fdf30b225e1c
- parent 1443
- cfde9737131e
- child 2192
- 5ae66d372d57
- permissions
- -rw-r--r--
8010521: jdk8 l10n resource file translation update 2
Reviewed-by: naoto, yhuang
| duke@1 | 1 | /* |
| jjg@1359 | 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 | |
| jjg@1443 | 30 | import com.sun.source.util.TreePath; |
| duke@1 | 31 | import com.sun.tools.javac.code.Symbol.ClassSymbol; |
| duke@1 | 32 | import com.sun.tools.javac.code.Symbol.MethodSymbol; |
| duke@1 | 33 | |
| duke@1 | 34 | /** |
| duke@1 | 35 | * Represents a constructor of a java class. |
| 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 | * @since 1.2 |
| duke@1 | 43 | * @author Robert Field |
| duke@1 | 44 | * @author Neal Gafter (rewrite) |
| duke@1 | 45 | */ |
| duke@1 | 46 | |
| duke@1 | 47 | public class ConstructorDocImpl |
| duke@1 | 48 | extends ExecutableMemberDocImpl implements ConstructorDoc { |
| duke@1 | 49 | |
| duke@1 | 50 | /** |
| duke@1 | 51 | * constructor. |
| duke@1 | 52 | */ |
| duke@1 | 53 | public ConstructorDocImpl(DocEnv env, MethodSymbol sym) { |
| duke@1 | 54 | super(env, sym); |
| duke@1 | 55 | } |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * constructor. |
| duke@1 | 59 | */ |
| jjg@1443 | 60 | public ConstructorDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) { |
| jjg@1443 | 61 | super(env, sym, treePath); |
| duke@1 | 62 | } |
| duke@1 | 63 | |
| duke@1 | 64 | /** |
| duke@1 | 65 | * Return true if it is a constructor, which it is. |
| duke@1 | 66 | * |
| duke@1 | 67 | * @return true |
| duke@1 | 68 | */ |
| duke@1 | 69 | public boolean isConstructor() { |
| duke@1 | 70 | return true; |
| duke@1 | 71 | } |
| duke@1 | 72 | |
| duke@1 | 73 | /** |
| duke@1 | 74 | * Get the name. |
| duke@1 | 75 | * |
| duke@1 | 76 | * @return the name of the member qualified by class (but not package) |
| duke@1 | 77 | */ |
| duke@1 | 78 | public String name() { |
| duke@1 | 79 | ClassSymbol c = sym.enclClass(); |
| duke@1 | 80 | String n = c.name.toString(); |
| duke@1 | 81 | for (c = c.owner.enclClass(); c != null; c = c.owner.enclClass()) { |
| duke@1 | 82 | n = c.name.toString() + "." + n; |
| duke@1 | 83 | } |
| duke@1 | 84 | return n; |
| duke@1 | 85 | } |
| duke@1 | 86 | |
| duke@1 | 87 | /** |
| duke@1 | 88 | * Get the name. |
| duke@1 | 89 | * |
| duke@1 | 90 | * @return the qualified name of the member. |
| duke@1 | 91 | */ |
| duke@1 | 92 | public String qualifiedName() { |
| duke@1 | 93 | return sym.enclClass().getQualifiedName().toString(); |
| duke@1 | 94 | } |
| duke@1 | 95 | |
| duke@1 | 96 | /** |
| duke@1 | 97 | * Returns a string representation of this constructor. Includes the |
| duke@1 | 98 | * qualified signature and any type parameters. |
| duke@1 | 99 | * Type parameters precede the class name, as they do in the syntax |
| duke@1 | 100 | * for invoking constructors with explicit type parameters using "new". |
| duke@1 | 101 | * (This is unlike the syntax for invoking methods with explicit type |
| duke@1 | 102 | * parameters.) |
| duke@1 | 103 | */ |
| duke@1 | 104 | public String toString() { |
| duke@1 | 105 | return typeParametersString() + qualifiedName() + signature(); |
| duke@1 | 106 | } |
| duke@1 | 107 | } |
