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 typeElement the class being documented 46 * @param memberDetailsTree the content tree representing member details 47 * @return content tree for the constructor details header 48 */ 49 Content getConstructorDetailsTreeHeader(TypeElement typeElement, 50 Content memberDetailsTree); 51 52 /** 53 * Get the constructor documentation tree header. 54 * 55 * @param constructor the constructor being documented 56 * @param constructorDetailsTree the content tree representing constructor details 57 * @return content tree for the constructor documentation header 58 */ 59 Content getConstructorDocTreeHeader(ExecutableElement constructor, 60 Content constructorDetailsTree); 61 62 /** 63 * Get the signature for the given constructor. 64 * 65 * @param constructor the constructor being documented 66 * @return content tree for the constructor signature 67 */ 68 Content getSignature(ExecutableElement constructor); 69 70 /** 71 * Add the deprecated output for the given constructor. 72 * 73 * @param constructor the constructor being documented 74 * @param constructorDocTree content tree to which the deprecated information will be added 75 */ 76 void addDeprecated(ExecutableElement constructor, Content constructorDocTree); 77 78 /** 79 * Add the comments for the given constructor. 80 * 81 * @param constructor the constructor being documented 82 * @param constructorDocTree the content tree to which the comments will be added 83 */ 84 void addComments(ExecutableElement constructor, Content constructorDocTree); 85 86 /** 87 * Add the tags for the given constructor. 88 * 89 * @param constructor the constructor being documented 90 * @param constructorDocTree the content tree to which the tags will be added 91 */ 92 void addTags(ExecutableElement constructor, Content constructorDocTree); 93 94 /** 95 * Get the constructor details tree. 96 * 97 * memberDetailsTreeHeader the content tree representing member details header 98 * @param memberDetailsTree the content tree representing member details 99 * @return content tree for the constructor details 100 */ 101 Content getConstructorDetails(Content memberDetailsTreeHeader, Content memberDetailsTree); 102 103 /** 104 * Get the constructor documentation. 105 * 106 * @param constructorDocTree the content tree representing constructor documentation 107 * @return content tree for the constructor documentation 108 */ 109 Content getConstructorDoc(Content constructorDocTree); 110 111 /** 112 * Let the writer know whether a non public constructor was found. 113 * 114 * @param foundNonPubConstructor true if we found a non public constructor. 115 */ 116 void setFoundNonPubConstructor(boolean foundNonPubConstructor); 117 118 /** 119 * Gets the member header tree. 120 * 121 * @return a content tree for the member header 122 */ 123 Content getMemberTreeHeader(); 124 }