Wed, 13 Apr 2011 11:35:43 -0700
7032975: API files in javax.annotation.processing need to be updated for references to JLS
7032972: API files in javax.tools need to updated for references to JVM Spec with editions/hyperlinks
7032978: API files in javax.tools need to be updated for references to JLS with editions/hyperlinks
Summary: Removed URLs and 'edition' references
Reviewed-by: jjg, darcy
1 /*
2 * Copyright (c) 2003, 2010, 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 */
26 package com.sun.tools.doclets.internal.toolkit;
28 import java.io.*;
29 import com.sun.javadoc.*;
31 /**
32 * The interface for writing constructor output.
33 *
34 * This code is not part of an API.
35 * It is implementation that is subject to change.
36 * Do not use it as an API
37 *
38 * @author Jamie Ho
39 * @author Bhavesh Patel (Modified)
40 * @since 1.5
41 */
43 public interface ConstructorWriter {
45 /**
46 * Get the constructor details tree header.
47 *
48 * @param classDoc the class being documented
49 * @param memberDetailsTree the content tree representing member details
50 * @return content tree for the constructor details header
51 */
52 public Content getConstructorDetailsTreeHeader(ClassDoc classDoc,
53 Content memberDetailsTree);
55 /**
56 * Get the constructor documentation tree header.
57 *
58 * @param constructor the constructor being documented
59 * @param constructorDetailsTree the content tree representing constructor details
60 * @return content tree for the constructor documentation header
61 */
62 public Content getConstructorDocTreeHeader(ConstructorDoc constructor,
63 Content constructorDetailsTree);
65 /**
66 * Get the signature for the given constructor.
67 *
68 * @param constructor the constructor being documented
69 * @return content tree for the constructor signature
70 */
71 public Content getSignature(ConstructorDoc constructor);
73 /**
74 * Add the deprecated output for the given constructor.
75 *
76 * @param constructor the constructor being documented
77 * @param constructorDocTree content tree to which the deprecated information will be added
78 */
79 public void addDeprecated(ConstructorDoc constructor, Content constructorDocTree);
81 /**
82 * Add the comments for the given constructor.
83 *
84 * @param constructor the constructor being documented
85 * @param constructorDocTree the content tree to which the comments will be added
86 */
87 public void addComments(ConstructorDoc constructor, Content constructorDocTree);
89 /**
90 * Add the tags for the given constructor.
91 *
92 * @param constructor the constructor being documented
93 * @param constructorDocTree the content tree to which the tags will be added
94 */
95 public void addTags(ConstructorDoc constructor, Content constructorDocTree);
97 /**
98 * Get the constructor details tree.
99 *
100 * @param memberDetailsTree the content tree representing member details
101 * @return content tree for the constructor details
102 */
103 public Content getConstructorDetails(Content memberDetailsTree);
105 /**
106 * Get the constructor documentation.
107 *
108 * @param constructorDocTree the content tree representing constructor documentation
109 * @param isLastContent true if the content to be added is the last content
110 * @return content tree for the constructor documentation
111 */
112 public Content getConstructorDoc(Content constructorDocTree, boolean isLastContent);
114 /**
115 * Let the writer know whether a non public constructor was found.
116 *
117 * @param foundNonPubConstructor true if we found a non public constructor.
118 */
119 public void setFoundNonPubConstructor(boolean foundNonPubConstructor);
121 /**
122 * Close the writer.
123 */
124 public void close() throws IOException;
125 }