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 */
25
26package com.sun.tools.javadoc.main;
27
28import com.sun.javadoc.*;
29
30import com.sun.source.util.TreePath;
31import com.sun.tools.javac.code.Symbol.ClassSymbol;
32import com.sun.tools.javac.code.Symbol.MethodSymbol;
33
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 */
46
47@Deprecated
48public class ConstructorDocImpl
49        extends ExecutableMemberDocImpl implements ConstructorDoc {
50
51    /**
52     * constructor.
53     */
54    public ConstructorDocImpl(DocEnv env, MethodSymbol sym) {
55        super(env, sym);
56    }
57
58    /**
59     * constructor.
60     */
61    public ConstructorDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
62        super(env, sym, treePath);
63    }
64
65    /**
66     * Return true if it is a constructor, which it is.
67     *
68     * @return true
69     */
70    public boolean isConstructor() {
71        return true;
72    }
73
74    /**
75     * Get the name.
76     *
77     * @return the name of the member.
78     */
79    public String name() {
80        ClassSymbol c = sym.enclClass();
81        return c.name.toString();
82    }
83
84    /**
85     * Get the name.
86     *
87     * @return the qualified name of the member.
88     */
89    public String qualifiedName() {
90        return sym.enclClass().getQualifiedName().toString();
91    }
92
93    /**
94     * Returns a string representation of this constructor.  Includes the
95     * qualified signature and any type parameters.
96     * Type parameters precede the class name, as they do in the syntax
97     * for invoking constructors with explicit type parameters using "new".
98     * (This is unlike the syntax for invoking methods with explicit type
99     * parameters.)
100     */
101    public String toString() {
102        return typeParametersString() + qualifiedName() + signature();
103    }
104}
105