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

Tue, 24 Dec 2013 09:17:37 -0800

author
ksrini
date
Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227
998b10c43157
parent 2192
5ae66d372d57
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

     1 /*
     2  * Copyright (c) 1997, 2013, 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.source.util.TreePath;
    31 import com.sun.tools.javac.code.Symbol.ClassSymbol;
    32 import com.sun.tools.javac.code.Symbol.MethodSymbol;
    34 /**
    35  * Represents a constructor of a java class.
    36  *
    37  *  <p><b>This is NOT part of any supported API.
    38  *  If you write code that depends on this, you do so at your own risk.
    39  *  This code and its internal interfaces are subject to change or
    40  *  deletion without notice.</b>
    41  *
    42  * @since 1.2
    43  * @author Robert Field
    44  * @author Neal Gafter (rewrite)
    45  */
    47 public class ConstructorDocImpl
    48         extends ExecutableMemberDocImpl implements ConstructorDoc {
    50     /**
    51      * constructor.
    52      */
    53     public ConstructorDocImpl(DocEnv env, MethodSymbol sym) {
    54         super(env, sym);
    55     }
    57     /**
    58      * constructor.
    59      */
    60     public ConstructorDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
    61         super(env, sym, treePath);
    62     }
    64     /**
    65      * Return true if it is a constructor, which it is.
    66      *
    67      * @return true
    68      */
    69     public boolean isConstructor() {
    70         return true;
    71     }
    73     /**
    74      * Get the name.
    75      *
    76      * @return the name of the member.
    77      */
    78     public String name() {
    79         ClassSymbol c = sym.enclClass();
    80         return c.name.toString();
    81     }
    83     /**
    84      * Get the name.
    85      *
    86      * @return the qualified name of the member.
    87      */
    88     public String qualifiedName() {
    89         return sym.enclClass().getQualifiedName().toString();
    90     }
    92     /**
    93      * Returns a string representation of this constructor.  Includes the
    94      * qualified signature and any type parameters.
    95      * Type parameters precede the class name, as they do in the syntax
    96      * for invoking constructors with explicit type parameters using "new".
    97      * (This is unlike the syntax for invoking methods with explicit type
    98      * parameters.)
    99      */
   100     public String toString() {
   101         return typeParametersString() + qualifiedName() + signature();
   102     }
   103 }

mercurial