duke@1: /*
jjg@1359:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
jjg@1443: import com.sun.source.util.TreePath;
duke@1: import com.sun.tools.javac.code.Symbol.ClassSymbol;
duke@1: import com.sun.tools.javac.code.Symbol.MethodSymbol;
duke@1: 
duke@1: /**
duke@1:  * Represents a constructor of a java class.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @since 1.2
duke@1:  * @author Robert Field
duke@1:  * @author Neal Gafter (rewrite)
duke@1:  */
duke@1: 
duke@1: public class ConstructorDocImpl
duke@1:         extends ExecutableMemberDocImpl implements ConstructorDoc {
duke@1: 
duke@1:     /**
duke@1:      * constructor.
duke@1:      */
duke@1:     public ConstructorDocImpl(DocEnv env, MethodSymbol sym) {
duke@1:         super(env, sym);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * constructor.
duke@1:      */
jjg@1443:     public ConstructorDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
jjg@1443:         super(env, sym, treePath);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if it is a constructor, which it is.
duke@1:      *
duke@1:      * @return true
duke@1:      */
duke@1:     public boolean isConstructor() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Get the name.
duke@1:      *
duke@1:      * @return the name of the member qualified by class (but not package)
duke@1:      */
duke@1:     public String name() {
duke@1:         ClassSymbol c = sym.enclClass();
duke@1:         String n = c.name.toString();
duke@1:         for (c = c.owner.enclClass(); c != null; c = c.owner.enclClass()) {
duke@1:             n = c.name.toString() + "." + n;
duke@1:         }
duke@1:         return n;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Get the name.
duke@1:      *
duke@1:      * @return the qualified name of the member.
duke@1:      */
duke@1:     public String qualifiedName() {
duke@1:         return sym.enclClass().getQualifiedName().toString();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns a string representation of this constructor.  Includes the
duke@1:      * qualified signature and any type parameters.
duke@1:      * Type parameters precede the class name, as they do in the syntax
duke@1:      * for invoking constructors with explicit type parameters using "new".
duke@1:      * (This is unlike the syntax for invoking methods with explicit type
duke@1:      * parameters.)
duke@1:      */
duke@1:     public String toString() {
duke@1:         return typeParametersString() + qualifiedName() + signature();
duke@1:     }
duke@1: }