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.util;
27
28 import java.io.*;
29
30 import javax.lang.model.element.ModuleElement;
31 import javax.lang.model.element.PackageElement;
32
33 import jdk.javadoc.doclet.DocletEnvironment;
34 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
35
36
37 /**
38 * Write out the element index.
39 *
40 * <p><b>This is NOT part of any supported API.
41 * If you write code that depends on this, you do so at your own risk.
42 * This code and its internal interfaces are subject to change or
43 * deletion without notice.</b>
44 */
45 public class ElementListWriter {
46
47 private final BaseConfiguration configuration;
48 private final Utils utils;
49 private final DocFile file;
50
51 /**
52 * Constructor.
53 *
54 * @param configuration the current configuration of the doclet.
55 */
56 public ElementListWriter(BaseConfiguration configuration) {
57 file = DocFile.createFileForOutput(configuration, DocPaths.ELEMENT_LIST);
58 this.configuration = configuration;
59 this.utils = configuration.utils;
60 }
61
62 /**
63 * Generate the element index.
64 *
65 * @param configuration the current configuration of the doclet.
66 * @throws DocFileIOException if there is a problem writing the output
67 */
68 public static void generate(BaseConfiguration configuration) throws DocFileIOException {
69 ElementListWriter elemgen = new ElementListWriter(configuration);
70 elemgen.generateElementListFile(configuration.docEnv);
71 }
72
73 protected void generateElementListFile(DocletEnvironment docEnv) throws DocFileIOException {
74 try (BufferedWriter out = new BufferedWriter(file.openWriter())) {
75 if (configuration.showModules) {
76 for (ModuleElement mdle : configuration.modulePackages.keySet()) {
77 if (!(configuration.nodeprecated && utils.isDeprecated(mdle))) {
78 out.write(DocletConstants.MODULE_PREFIX + mdle.toString());
79 out.newLine();
80 for (PackageElement pkg : configuration.modulePackages.get(mdle)) {
81 out.write(pkg.toString());
82 out.newLine();
83 }
84 }
85 }
86 } else {
87 for (PackageElement pkg : configuration.packages) {
88 // if the -nodeprecated option is set and the package is marked as
89 // deprecated, do not include it in the packages list.
90 if (!(configuration.nodeprecated && utils.isDeprecated(pkg))) {
91 out.write(pkg.toString());
92 out.newLine();
93 }
94 }
95 }
96 } catch (IOException e) {
97 throw new DocFileIOException(file, DocFileIOException.Mode.WRITE, e);
98 }
99 }
100 }
|
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.util;
27
28 import java.io.*;
29
30 import javax.lang.model.element.ModuleElement;
31 import javax.lang.model.element.PackageElement;
32
33 import jdk.javadoc.doclet.DocletEnvironment;
34 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
35 import jdk.javadoc.internal.doclets.toolkit.BaseOptions;
36
37
38 /**
39 * Write out the element index.
40 *
41 * <p><b>This is NOT part of any supported API.
42 * If you write code that depends on this, you do so at your own risk.
43 * This code and its internal interfaces are subject to change or
44 * deletion without notice.</b>
45 */
46 public class ElementListWriter {
47
48 private final BaseConfiguration configuration;
49 private final BaseOptions options;
50 private final Utils utils;
51 private final DocFile file;
52
53 /**
54 * Constructor.
55 *
56 * @param configuration the current configuration of the doclet.
57 */
58 public ElementListWriter(BaseConfiguration configuration) {
59 file = DocFile.createFileForOutput(configuration, DocPaths.ELEMENT_LIST);
60 this.configuration = configuration;
61 this.options = configuration.getOptions();
62 this.utils = configuration.utils;
63 }
64
65 /**
66 * Generate the element index.
67 *
68 * @param configuration the current configuration of the doclet.
69 * @throws DocFileIOException if there is a problem writing the output
70 */
71 public static void generate(BaseConfiguration configuration) throws DocFileIOException {
72 ElementListWriter elemgen = new ElementListWriter(configuration);
73 elemgen.generateElementListFile(configuration.docEnv);
74 }
75
76 protected void generateElementListFile(DocletEnvironment docEnv) throws DocFileIOException {
77 try (BufferedWriter out = new BufferedWriter(file.openWriter())) {
78 if (configuration.showModules) {
79 for (ModuleElement mdle : configuration.modulePackages.keySet()) {
80 if (!(options.noDeprecated && utils.isDeprecated(mdle))) {
81 out.write(DocletConstants.MODULE_PREFIX + mdle.toString());
82 out.newLine();
83 for (PackageElement pkg : configuration.modulePackages.get(mdle)) {
84 out.write(pkg.toString());
85 out.newLine();
86 }
87 }
88 }
89 } else {
90 for (PackageElement pkg : configuration.packages) {
91 // if the -nodeprecated option is set and the package is marked as
92 // deprecated, do not include it in the packages list.
93 if (!(options.noDeprecated && utils.isDeprecated(pkg))) {
94 out.write(pkg.toString());
95 out.newLine();
96 }
97 }
98 }
99 } catch (IOException e) {
100 throw new DocFileIOException(file, DocFileIOException.Mode.WRITE, e);
101 }
102 }
103 }
|