1 /* 2 * Copyright (c) 2003, 2019, 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 jdk.javadoc.internal.doclets.toolkit; 27 28 import javax.lang.model.element.ExecutableElement; 29 import javax.lang.model.element.TypeElement; 30 31 /** 32 * The interface for writing constructor output. 33 * 34 * <p><b>This is NOT part of any supported API. 35 * If you write code that depends on this, you do so at your own risk. 36 * This code and its internal interfaces are subject to change or 37 * deletion without notice.</b> 38 */ 39 40 public interface ConstructorWriter { 41 42 /** 43 * Get the constructor details tree header. 44 * 45 * @param memberDetailsTree the content tree representing member details 46 * @return content tree for the constructor details header 47 */ 48 Content getConstructorDetailsTreeHeader(Content memberDetailsTree); 49 50 /** 51 * Get the constructor documentation tree header. 52 * 53 * @param constructor the constructor being documented 54 * @return content tree for the constructor documentation header 55 */ 56 Content getConstructorDocTreeHeader(ExecutableElement constructor); 57 58 /** 59 * Get the signature for the given constructor. 60 * 61 * @param constructor the constructor being documented 62 * @return content tree for the constructor signature 63 */ 64 Content getSignature(ExecutableElement constructor); 65 66 /** 67 * Add the deprecated output for the given constructor. 68 * 69 * @param constructor the constructor being documented 70 * @param constructorDocTree content tree to which the deprecated information will be added 71 */ 72 void addDeprecated(ExecutableElement constructor, Content constructorDocTree); 73 74 /** 75 * Add the comments for the given constructor. 76 * 77 * @param constructor the constructor being documented 78 * @param constructorDocTree the content tree to which the comments will be added 79 */ 80 void addComments(ExecutableElement constructor, Content constructorDocTree); 81 82 /** 83 * Add the tags for the given constructor. 84 * 85 * @param constructor the constructor being documented 86 * @param constructorDocTree the content tree to which the tags will be added 87 */ 88 void addTags(ExecutableElement constructor, Content constructorDocTree); 89 90 /** 91 * Get the constructor details tree. 92 * 93 * memberDetailsTreeHeader the content tree representing member details header 94 * @param memberDetailsTree the content tree representing member details 95 * @return content tree for the constructor details 96 */ 97 Content getConstructorDetails(Content memberDetailsTreeHeader, Content memberDetailsTree); 98 99 /** 100 * Get the constructor documentation. 101 * 102 * @param constructorDocTree the content tree representing constructor documentation 103 * @return content tree for the constructor documentation 104 */ 105 Content getConstructorDoc(Content constructorDocTree); 106 107 /** 108 * Let the writer know whether a non public constructor was found. 109 * 110 * @param foundNonPubConstructor true if we found a non public constructor. 111 */ 112 void setFoundNonPubConstructor(boolean foundNonPubConstructor); 113 114 /** 115 * Gets the member header tree. 116 * 117 * @return a content tree for the member header 118 */ 119 Content getMemberTreeHeader(); 120 }