-
Notifications
You must be signed in to change notification settings - Fork 61
/
ElementListWriter.java
105 lines (95 loc) · 4.22 KB
/
ElementListWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.toolkit.util;
import java.io.*;
import javax.lang.model.element.ModuleElement;
import javax.lang.model.element.PackageElement;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
import jdk.javadoc.internal.doclets.toolkit.BaseOptions;
/**
* Write out the element index.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.</b>
*/
public class ElementListWriter {
private final BaseConfiguration configuration;
private final BaseOptions options;
private final Utils utils;
private final DocFile file;
/**
* Constructor.
*
* @param configuration the current configuration of the doclet.
*/
public ElementListWriter(BaseConfiguration configuration) {
file = DocFile.createFileForOutput(configuration, DocPaths.ELEMENT_LIST);
this.configuration = configuration;
this.options = configuration.getOptions();
this.utils = configuration.utils;
}
/**
* Generate the element index.
*
* @param configuration the current configuration of the doclet.
* @throws DocFileIOException if there is a problem writing the output
*/
public static void generate(BaseConfiguration configuration) throws DocFileIOException {
ElementListWriter elemgen = new ElementListWriter(configuration);
elemgen.generateElementListFile(configuration.docEnv);
}
protected void generateElementListFile(DocletEnvironment docEnv) throws DocFileIOException {
try (Writer fileWriter = file.openWriter();
BufferedWriter out = (fileWriter instanceof BufferedWriter b) ? b
: new BufferedWriter(fileWriter)) {
if (configuration.showModules) {
for (ModuleElement mdle : configuration.modulePackages.keySet()) {
if (!(options.noDeprecated() && utils.isDeprecated(mdle))) {
out.write(DocletConstants.MODULE_PREFIX + mdle.toString());
out.newLine();
for (PackageElement pkg : configuration.modulePackages.get(mdle)) {
out.write(pkg.toString());
out.newLine();
}
}
}
} else {
for (PackageElement pkg : configuration.packages) {
// if the -nodeprecated option is set and the package is marked as
// deprecated, do not include it in the packages list.
if (!(options.noDeprecated() && utils.isDeprecated(pkg))) {
out.write(pkg.toString());
out.newLine();
}
}
}
} catch (IOException e) {
throw new DocFileIOException(file, DocFileIOException.Mode.WRITE, e);
}
}
}