/*

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

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

 *

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

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

 * published by the Free Software Foundation.  Oracle designates this

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

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

 *

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

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

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

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

 * accompanied this code).

 *

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

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

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

 *

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

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

 * questions.

 */

import com.sun.javadoc.*;

import com.sun.source.util.TreePath;

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

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

/**

 * Represents a constructor of a java class.

 *

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

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

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

 *  deletion without notice.</b>

 *

 * @since 1.2

 * @author Robert Field

 * @author Neal Gafter (rewrite)

 */

public class ConstructorDocImpl

        extends ExecutableMemberDocImpl implements ConstructorDoc {

    /**

     * constructor.

     */

    public ConstructorDocImpl(DocEnv env, MethodSymbol sym) {

        super(env, sym);

    }

    /**

     * constructor.

     */

    public ConstructorDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {

        super(env, sym, treePath);

    }

    /**

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

     *

     * @return true

     */

    public boolean isConstructor() {

        return true;

    }

    /**

     * Get the name.

     *

     * @return the name of the member.

     */

    public String name() {

        ClassSymbol c = sym.enclClass();

        return c.name.toString();

    }

    /**

     * Get the name.

     *

     * @return the qualified name of the member.

     */

    public String qualifiedName() {

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

    }

    /**

     * Returns a string representation of this constructor.  Includes the

     * qualified signature and any type parameters.

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

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

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

     * parameters.)

     */

    public String toString() {

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

    }

}