jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/javadoc/ConstructorDocImpl.java@78962d89f283

8000741: refactor javadoc to use abstraction to handle relative paths
Reviewed-by: darcy

     1 /*

     2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.javadoc;

    28 import com.sun.javadoc.*;

    30 import com.sun.tools.javac.code.Symbol.ClassSymbol;

    31 import com.sun.tools.javac.code.Symbol.MethodSymbol;

    32 import com.sun.tools.javac.tree.JCTree.JCMethodDecl;

    33 import com.sun.tools.javac.util.Position;

    35 /**

    36  * Represents a constructor of a java class.

    37  *

    38  *  <p><b>This is NOT part of any supported API.

    39  *  If you write code that depends on this, you do so at your own risk.

    40  *  This code and its internal interfaces are subject to change or

    41  *  deletion without notice.</b>

    42  *

    43  * @since 1.2

    44  * @author Robert Field

    45  * @author Neal Gafter (rewrite)

    46  */

    48 public class ConstructorDocImpl

    49         extends ExecutableMemberDocImpl implements ConstructorDoc {

    51     /**

    52      * constructor.

    53      */

    54     public ConstructorDocImpl(DocEnv env, MethodSymbol sym) {

    55         super(env, sym);

    56     }

    58     /**

    59      * constructor.

    60      */

    61     public ConstructorDocImpl(DocEnv env, MethodSymbol sym,

    62                               String docComment, JCMethodDecl tree, Position.LineMap lineMap) {

    63         super(env, sym, docComment, tree, lineMap);

    64     }

    66     /**

    67      * Return true if it is a constructor, which it is.

    68      *

    69      * @return true

    70      */

    71     public boolean isConstructor() {

    72         return true;

    73     }

    75     /**

    76      * Get the name.

    77      *

    78      * @return the name of the member qualified by class (but not package)

    79      */

    80     public String name() {

    81         ClassSymbol c = sym.enclClass();

    82         String n = c.name.toString();

    83         for (c = c.owner.enclClass(); c != null; c = c.owner.enclClass()) {

    84             n = c.name.toString() + "." + n;

    85         }

    86         return n;

    87     }

    89     /**

    90      * Get the name.

    91      *

    92      * @return the qualified name of the member.

    93      */

    94     public String qualifiedName() {

    95         return sym.enclClass().getQualifiedName().toString();

    96     }

    98     /**

    99      * Returns a string representation of this constructor.  Includes the

   100      * qualified signature and any type parameters.

   101      * Type parameters precede the class name, as they do in the syntax

   102      * for invoking constructors with explicit type parameters using "new".

   103      * (This is unlike the syntax for invoking methods with explicit type

   104      * parameters.)

   105      */

   106     public String toString() {

   107         return typeParametersString() + qualifiedName() + signature();

   108     }

   109 }

Mercurial > jdk8-mips64-public > langtools / file revision