author | jjg |
Mon, 22 Aug 2016 16:32:40 -0700 | |
changeset 40587 | 1c355ea550ed |
parent 38617 | d93a7f64e231 |
child 43261 | d377e97291d8 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
40587 | 2 |
* Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.doclets.internal.toolkit.builders; |
|
27 |
||
28 |
import java.io.*; |
|
29 |
import java.lang.reflect.*; |
|
30 |
import java.util.*; |
|
31 |
||
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20600
diff
changeset
|
32 |
import com.sun.javadoc.PackageDoc; |
14258 | 33 |
import com.sun.tools.doclets.internal.toolkit.*; |
34 |
import com.sun.tools.doclets.internal.toolkit.util.*; |
|
35 |
||
10 | 36 |
/** |
37 |
* The superclass for all builders. A builder is a class that provides |
|
38 |
* the structure and content of API documentation. A builder is completely |
|
39 |
* doclet independent which means that any doclet can use builders to |
|
40 |
* construct documentation, as long as it impelements the appropriate |
|
41 |
* writer interfaces. For example, if a doclet wanted to use |
|
42 |
* {@link ConstantsSummaryBuilder} to build a constant summary, all it has to |
|
43 |
* do is implement the ConstantsSummaryWriter interface and pass it to the |
|
44 |
* builder using a WriterFactory. |
|
45 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
46 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
47 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
48 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
49 |
* deletion without notice.</b> |
10 | 50 |
* |
51 |
* @author Jamie Ho |
|
52 |
* @since 1.5 |
|
53 |
*/ |
|
54 |
||
38617 | 55 |
@Deprecated |
10 | 56 |
public abstract class AbstractBuilder { |
14542 | 57 |
public static class Context { |
58 |
/** |
|
59 |
* The configuration used in this run of the doclet. |
|
60 |
*/ |
|
61 |
final Configuration configuration; |
|
62 |
||
63 |
/** |
|
64 |
* Keep track of which packages we have seen for |
|
65 |
* efficiency purposes. We don't want to copy the |
|
66 |
* doc files multiple times for a single package. |
|
67 |
*/ |
|
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20600
diff
changeset
|
68 |
final Set<PackageDoc> containingPackagesSeen; |
14542 | 69 |
|
70 |
/** |
|
71 |
* Shared parser for the builder XML file |
|
72 |
*/ |
|
73 |
final LayoutParser layoutParser; |
|
74 |
||
75 |
Context(Configuration configuration, |
|
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20600
diff
changeset
|
76 |
Set<PackageDoc> containingPackagesSeen, |
14542 | 77 |
LayoutParser layoutParser) { |
78 |
this.configuration = configuration; |
|
79 |
this.containingPackagesSeen = containingPackagesSeen; |
|
80 |
this.layoutParser = layoutParser; |
|
81 |
} |
|
82 |
} |
|
10 | 83 |
|
84 |
/** |
|
85 |
* The configuration used in this run of the doclet. |
|
86 |
*/ |
|
14542 | 87 |
protected final Configuration configuration; |
10 | 88 |
|
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
24221
diff
changeset
|
89 |
protected final Utils utils; |
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
24221
diff
changeset
|
90 |
|
10 | 91 |
/** |
92 |
* Keep track of which packages we have seen for |
|
93 |
* efficiency purposes. We don't want to copy the |
|
94 |
* doc files multiple times for a single package. |
|
95 |
*/ |
|
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20600
diff
changeset
|
96 |
protected final Set<PackageDoc> containingPackagesSeen; |
14542 | 97 |
|
98 |
protected final LayoutParser layoutParser; |
|
10 | 99 |
|
100 |
/** |
|
101 |
* True if we want to print debug output. |
|
102 |
*/ |
|
103 |
protected static final boolean DEBUG = false; |
|
104 |
||
105 |
/** |
|
106 |
* Construct a Builder. |
|
107 |
* @param configuration the configuration used in this run |
|
108 |
* of the doclet. |
|
109 |
*/ |
|
14542 | 110 |
public AbstractBuilder(Context c) { |
111 |
this.configuration = c.configuration; |
|
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
24221
diff
changeset
|
112 |
this.utils = configuration.utils; |
14542 | 113 |
this.containingPackagesSeen = c.containingPackagesSeen; |
114 |
this.layoutParser = c.layoutParser; |
|
10 | 115 |
} |
116 |
||
117 |
/** |
|
118 |
* Return the name of this builder. |
|
119 |
* |
|
120 |
* @return the name of the builder. |
|
121 |
*/ |
|
122 |
public abstract String getName(); |
|
123 |
||
124 |
/** |
|
125 |
* Build the documentation. |
|
126 |
* |
|
40587 | 127 |
* @throws IOException if there is a problem writing the output |
10 | 128 |
*/ |
129 |
public abstract void build() throws IOException; |
|
130 |
||
131 |
/** |
|
5855 | 132 |
* Build the documentation, as specified by the given XML element. |
10 | 133 |
* |
5855 | 134 |
* @param node the XML element that specifies which component to document. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
135 |
* @param contentTree content tree to which the documentation will be added |
10 | 136 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
137 |
protected void build(XMLNode node, Content contentTree) { |
5855 | 138 |
String component = node.name; |
139 |
try { |
|
140 |
invokeMethod("build" + component, |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
141 |
new Class<?>[]{XMLNode.class, Content.class}, |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
142 |
new Object[]{node, contentTree}); |
5855 | 143 |
} catch (NoSuchMethodException e) { |
144 |
e.printStackTrace(); |
|
145 |
configuration.root.printError("Unknown element: " + component); |
|
19667
fdfce85627a9
8001669: javadoc internal DocletAbortException should set cause when appropriate
jjg
parents:
14542
diff
changeset
|
146 |
throw new DocletAbortException(e); |
5855 | 147 |
} catch (InvocationTargetException e) { |
20600
052970964bc1
6978886: javadoc shows stacktrace after print error resulting from disk full
kizune
parents:
19667
diff
changeset
|
148 |
throw new DocletAbortException(e.getCause()); |
5855 | 149 |
} catch (Exception e) { |
150 |
e.printStackTrace(); |
|
151 |
configuration.root.printError("Exception " + |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
152 |
e.getClass().getName() + |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
153 |
" thrown while processing element: " + component); |
19667
fdfce85627a9
8001669: javadoc internal DocletAbortException should set cause when appropriate
jjg
parents:
14542
diff
changeset
|
154 |
throw new DocletAbortException(e); |
10 | 155 |
} |
156 |
} |
|
157 |
||
158 |
/** |
|
5855 | 159 |
* Build the documentation, as specified by the children of the given XML element. |
160 |
* |
|
161 |
* @param node the XML element that specifies which components to document. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
162 |
* @param contentTree content tree to which the documentation will be added |
5855 | 163 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
164 |
protected void buildChildren(XMLNode node, Content contentTree) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
165 |
for (XMLNode child : node.children) |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
166 |
build(child, contentTree); |
5855 | 167 |
} |
168 |
||
169 |
/** |
|
10 | 170 |
* Given the name and parameters, invoke the method in the builder. This |
171 |
* method is required to invoke the appropriate build method as instructed |
|
172 |
* by the builder XML file. |
|
173 |
* |
|
174 |
* @param methodName the name of the method that we would like to invoke. |
|
175 |
* @param paramClasses the types for each parameter. |
|
176 |
* @param params the parameters of the method. |
|
177 |
*/ |
|
5855 | 178 |
protected void invokeMethod(String methodName, Class<?>[] paramClasses, |
10 | 179 |
Object[] params) |
5855 | 180 |
throws Exception { |
181 |
if (DEBUG) { |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
182 |
configuration.root.printError("DEBUG: " + this.getClass().getName() + "." + methodName); |
5855 | 183 |
} |
184 |
Method method = this.getClass().getMethod(methodName, paramClasses); |
|
185 |
method.invoke(this, params); |
|
186 |
} |
|
10 | 187 |
} |