author | alanb |
Thu, 17 Mar 2016 19:04:28 +0000 | |
changeset 36526 | 3b41f1c69604 |
parent 35426 | 374342e56a56 |
child 40229 | 09f4478d07e5 |
permissions | -rw-r--r-- |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
1 |
/* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2 |
* Copyright (c) 1998, 2016, Oracle and/or its affiliates. All rights reserved. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
4 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
10 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
15 |
* accompanied this code). |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
16 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
20 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
23 |
* questions. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
24 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
25 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.toolkit.util; |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
27 |
|
36526 | 28 |
import javax.lang.model.element.ModuleElement; |
29 |
||
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
30 |
/** |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
31 |
* Standard DocPath objects. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
32 |
* |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
33 |
* <p><b>This is NOT part of any supported API. |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
34 |
* If you write code that depends on this, you do so at your own risk. |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
35 |
* This code and its internal interfaces are subject to change or |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
36 |
* deletion without notice.</b> |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
37 |
* |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
38 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
39 |
public class DocPaths { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
40 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
41 |
/** The name of the file for all classes, using frames. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
42 |
public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
43 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
44 |
/** The name of the file for all classes, without using frames. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
45 |
public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
46 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
47 |
/** The name of the sub-directory for storing class usage info. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
48 |
public static final DocPath CLASS_USE = DocPath.create("class-use"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
49 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
50 |
/** The name of the file for constant values. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
51 |
public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
52 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
53 |
/** The name of the fie for deprecated elements. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
54 |
public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
55 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
56 |
/** The name of the subdirectory for user-provided additional documentation files. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
57 |
public static final DocPath DOC_FILES = DocPath.create("doc-files"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
58 |
|
33920 | 59 |
/** The name of the image file showing a magnifying glass on the search box. */ |
60 |
public static final DocPath GLASS_IMG = DocPath.create("glass.png"); |
|
61 |
||
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
62 |
/** The name of the file for help info. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
63 |
public static final DocPath HELP_DOC = DocPath.create("help-doc.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
64 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
65 |
/** The name of the main index file. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
66 |
public static final DocPath INDEX = DocPath.create("index.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
67 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
68 |
/** The name of the single index file for all classes. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
69 |
public static final DocPath INDEX_ALL = DocPath.create("index-all.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
70 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
71 |
/** The name of the directory for the split index files. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
72 |
public static final DocPath INDEX_FILES = DocPath.create("index-files"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
73 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
74 |
/** Generate the name of one of the files in the split index. */ |
22163 | 75 |
public static DocPath indexN(int n) { |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
76 |
return DocPath.create("index-" + n + ".html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
77 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
78 |
|
14549
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14368
diff
changeset
|
79 |
/** The name of the default javascript file. */ |
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14368
diff
changeset
|
80 |
public static final DocPath JAVASCRIPT = DocPath.create("script.js"); |
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14368
diff
changeset
|
81 |
|
33920 | 82 |
/** The name of the directory for the jQuery. */ |
83 |
public static final DocPath JQUERY_FILES = DocPath.create("jquery"); |
|
84 |
||
85 |
/** The name of the default jQuery stylesheet file. */ |
|
86 |
public static final DocPath JQUERY_STYLESHEET_FILE = DocPath.create("jquery-ui.css"); |
|
87 |
||
88 |
/** The name of the default jQuery javascript file. */ |
|
89 |
public static final DocPath JQUERY_JS_1_10 = DocPath.create("jquery-1.10.2.js"); |
|
90 |
||
91 |
/** The name of the default jQuery javascript file. */ |
|
92 |
public static final DocPath JQUERY_JS = DocPath.create("jquery-ui.js"); |
|
93 |
||
94 |
/** The name of the default jszip javascript file. */ |
|
95 |
public static final DocPath JSZIP = DocPath.create("jszip/dist/jszip.js"); |
|
96 |
||
97 |
/** The name of the default jszip javascript file. */ |
|
98 |
public static final DocPath JSZIP_MIN = DocPath.create("jszip/dist/jszip.min.js"); |
|
99 |
||
100 |
/** The name of the default jszip-utils javascript file. */ |
|
101 |
public static final DocPath JSZIPUTILS = DocPath.create("jszip-utils/dist/jszip-utils.js"); |
|
102 |
||
103 |
/** The name of the default jszip-utils javascript file. */ |
|
104 |
public static final DocPath JSZIPUTILS_MIN = DocPath.create("jszip-utils/dist/jszip-utils.min.js"); |
|
105 |
||
106 |
/** The name of the default jszip-utils javascript file. */ |
|
107 |
public static final DocPath JSZIPUTILS_IE = DocPath.create("jszip-utils/dist/jszip-utils-ie.js"); |
|
108 |
||
109 |
/** The name of the default jszip-utils javascript file. */ |
|
110 |
public static final DocPath JSZIPUTILS_IE_MIN = DocPath.create("jszip-utils/dist/jszip-utils-ie.min.js"); |
|
111 |
||
112 |
/** The name of the member search index file. */ |
|
113 |
public static final DocPath MEMBER_SEARCH_INDEX_JSON = DocPath.create("member-search-index.json"); |
|
114 |
||
115 |
/** The name of the member search index zip file. */ |
|
116 |
public static final DocPath MEMBER_SEARCH_INDEX_ZIP = DocPath.create("member-search-index.zip"); |
|
117 |
||
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
118 |
/** The name of the file for the overview frame. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
119 |
public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
120 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
121 |
/** The name of the file for the overview summary. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
122 |
public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
123 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
124 |
/** The name of the file for the overview tree. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
125 |
public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
126 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
127 |
/** The name of the file for the package frame. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
128 |
public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
129 |
|
33920 | 130 |
/** The name of the file for the package list. */ |
131 |
public static final DocPath PACKAGE_LIST = DocPath.create("package-list"); |
|
132 |
||
133 |
/** The name of the package search index file. */ |
|
134 |
public static final DocPath PACKAGE_SEARCH_INDEX_JSON = DocPath.create("package-search-index.json"); |
|
135 |
||
136 |
/** The name of the package search index zipfile. */ |
|
137 |
public static final DocPath PACKAGE_SEARCH_INDEX_ZIP = DocPath.create("package-search-index.zip"); |
|
138 |
||
139 |
/** The name of the file for the package summary. */ |
|
140 |
public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html"); |
|
141 |
||
142 |
/** The name of the file for the package tree. */ |
|
143 |
public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html"); |
|
144 |
||
145 |
/** The name of the file for the package usage info. */ |
|
146 |
public static final DocPath PACKAGE_USE = DocPath.create("package-use.html"); |
|
147 |
||
36526 | 148 |
/** The name of the file for the module frame. */ |
149 |
public static DocPath moduleFrame(ModuleElement mdle) { |
|
150 |
return DocPath.create(mdle.getQualifiedName() + "-frame.html"); |
|
151 |
} |
|
152 |
||
153 |
/** The name of the file for the module summary. */ |
|
154 |
public static DocPath moduleSummary(ModuleElement mdle) { |
|
155 |
return DocPath.create(mdle.getQualifiedName() + "-summary.html"); |
|
156 |
} |
|
157 |
||
158 |
/** The name of the file for the module overview frame. */ |
|
159 |
public static final DocPath MODULE_OVERVIEW_FRAME = DocPath.create("module-overview-frame.html"); |
|
160 |
||
22447 | 161 |
/** The name of the sub-package from which resources are read. */ |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
162 |
public static final DocPath RESOURCES = DocPath.create("resources"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
163 |
|
33920 | 164 |
/** The name of the search javascript file. */ |
165 |
public static final DocPath SEARCH_JS = DocPath.create("search.js"); |
|
166 |
||
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
167 |
/** The name of the file for the serialized form info. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
168 |
public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
169 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
170 |
/** The name of the directory in which HTML versions of the source code |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
171 |
* are generated. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
172 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
173 |
public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
174 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
175 |
/** The name of the default stylesheet. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
176 |
public static final DocPath STYLESHEET = DocPath.create("stylesheet.css"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
177 |
|
33920 | 178 |
/** The name of the tag search index file. */ |
179 |
public static final DocPath TAG_SEARCH_INDEX_JSON = DocPath.create("tag-search-index.json"); |
|
180 |
||
181 |
/** The name of the tag search index zip file. */ |
|
182 |
public static final DocPath TAG_SEARCH_INDEX_ZIP = DocPath.create("tag-search-index.zip"); |
|
183 |
||
184 |
/** The name of the type search index file. */ |
|
185 |
public static final DocPath TYPE_SEARCH_INDEX_JSON = DocPath.create("type-search-index.json"); |
|
186 |
||
187 |
/** The name of the type search index zip file. */ |
|
188 |
public static final DocPath TYPE_SEARCH_INDEX_ZIP = DocPath.create("type-search-index.zip"); |
|
189 |
||
190 |
/** The name of the image file for undo button on the search box. */ |
|
191 |
public static final DocPath X_IMG = DocPath.create("x.png"); |
|
192 |
||
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
193 |
} |