src/share/classes/com/sun/tools/javadoc/ConstructorDocImpl.java

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.javadoc;
aoqi@0 27
aoqi@0 28 import com.sun.javadoc.*;
aoqi@0 29
aoqi@0 30 import com.sun.source.util.TreePath;
aoqi@0 31 import com.sun.tools.javac.code.Symbol.ClassSymbol;
aoqi@0 32 import com.sun.tools.javac.code.Symbol.MethodSymbol;
aoqi@0 33
aoqi@0 34 /**
aoqi@0 35 * Represents a constructor of a java class.
aoqi@0 36 *
aoqi@0 37 * <p><b>This is NOT part of any supported API.
aoqi@0 38 * If you write code that depends on this, you do so at your own risk.
aoqi@0 39 * This code and its internal interfaces are subject to change or
aoqi@0 40 * deletion without notice.</b>
aoqi@0 41 *
aoqi@0 42 * @since 1.2
aoqi@0 43 * @author Robert Field
aoqi@0 44 * @author Neal Gafter (rewrite)
aoqi@0 45 */
aoqi@0 46
aoqi@0 47 public class ConstructorDocImpl
aoqi@0 48 extends ExecutableMemberDocImpl implements ConstructorDoc {
aoqi@0 49
aoqi@0 50 /**
aoqi@0 51 * constructor.
aoqi@0 52 */
aoqi@0 53 public ConstructorDocImpl(DocEnv env, MethodSymbol sym) {
aoqi@0 54 super(env, sym);
aoqi@0 55 }
aoqi@0 56
aoqi@0 57 /**
aoqi@0 58 * constructor.
aoqi@0 59 */
aoqi@0 60 public ConstructorDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
aoqi@0 61 super(env, sym, treePath);
aoqi@0 62 }
aoqi@0 63
aoqi@0 64 /**
aoqi@0 65 * Return true if it is a constructor, which it is.
aoqi@0 66 *
aoqi@0 67 * @return true
aoqi@0 68 */
aoqi@0 69 public boolean isConstructor() {
aoqi@0 70 return true;
aoqi@0 71 }
aoqi@0 72
aoqi@0 73 /**
aoqi@0 74 * Get the name.
aoqi@0 75 *
aoqi@0 76 * @return the name of the member.
aoqi@0 77 */
aoqi@0 78 public String name() {
aoqi@0 79 ClassSymbol c = sym.enclClass();
aoqi@0 80 return c.name.toString();
aoqi@0 81 }
aoqi@0 82
aoqi@0 83 /**
aoqi@0 84 * Get the name.
aoqi@0 85 *
aoqi@0 86 * @return the qualified name of the member.
aoqi@0 87 */
aoqi@0 88 public String qualifiedName() {
aoqi@0 89 return sym.enclClass().getQualifiedName().toString();
aoqi@0 90 }
aoqi@0 91
aoqi@0 92 /**
aoqi@0 93 * Returns a string representation of this constructor. Includes the
aoqi@0 94 * qualified signature and any type parameters.
aoqi@0 95 * Type parameters precede the class name, as they do in the syntax
aoqi@0 96 * for invoking constructors with explicit type parameters using "new".
aoqi@0 97 * (This is unlike the syntax for invoking methods with explicit type
aoqi@0 98 * parameters.)
aoqi@0 99 */
aoqi@0 100 public String toString() {
aoqi@0 101 return typeParametersString() + qualifiedName() + signature();
aoqi@0 102 }
aoqi@0 103 }

mercurial