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