DocPaths.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 1998, 2016, 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 */
25
26package jdk.javadoc.internal.doclets.toolkit.util;
27
28/**
29 * Standard DocPath objects.
30 *
31 *  <p><b>This is NOT part of any supported API.
32 *  If you write code that depends on this, you do so at your own risk.
33 *  This code and its internal interfaces are subject to change or
34 *  deletion without notice.</b>
35 *
36 */
37public class DocPaths {
38
39    /** The name of the file for all classes, using frames. */
40    public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html");
41
42    /** The name of the file for all classes, without using frames. */
43    public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html");
44
45    /** The name of the sub-directory for storing class usage info. */
46    public static final DocPath CLASS_USE = DocPath.create("class-use");
47
48    /** The name of the file for constant values. */
49    public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html");
50
51    /** The name of the fie for deprecated elements. */
52    public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
53
54    /** The name of the subdirectory for user-provided additional documentation files. */
55    public static final DocPath DOC_FILES = DocPath.create("doc-files");
56
57    /** The name of the image file showing a magnifying glass on the search box. */
58    public static final DocPath GLASS_IMG = DocPath.create("glass.png");
59
60    /** The name of the file for help info. */
61    public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
62
63    /** The name of the main index file. */
64    public static final DocPath INDEX = DocPath.create("index.html");
65
66    /** The name of the single index file for all classes. */
67    public static final DocPath INDEX_ALL = DocPath.create("index-all.html");
68
69    /** The name of the directory for the split index files. */
70    public static final DocPath INDEX_FILES = DocPath.create("index-files");
71
72    /** Generate the name of one of the files in the split index. */
73    public static DocPath indexN(int n) {
74        return DocPath.create("index-" + n + ".html");
75    }
76
77    /** The name of the default javascript file. */
78    public static final DocPath JAVASCRIPT = DocPath.create("script.js");
79
80    /** The name of the directory for the jQuery. */
81    public static final DocPath JQUERY_FILES = DocPath.create("jquery");
82
83    /** The name of the default jQuery stylesheet file. */
84    public static final DocPath JQUERY_STYLESHEET_FILE = DocPath.create("jquery-ui.css");
85
86    /** The name of the default jQuery javascript file. */
87    public static final DocPath JQUERY_JS_1_10 = DocPath.create("jquery-1.10.2.js");
88
89    /** The name of the default jQuery javascript file. */
90    public static final DocPath JQUERY_JS = DocPath.create("jquery-ui.js");
91
92    /** The name of the default jszip javascript file. */
93    public static final DocPath JSZIP = DocPath.create("jszip/dist/jszip.js");
94
95    /** The name of the default jszip javascript file. */
96    public static final DocPath JSZIP_MIN = DocPath.create("jszip/dist/jszip.min.js");
97
98    /** The name of the default jszip-utils javascript file. */
99    public static final DocPath JSZIPUTILS = DocPath.create("jszip-utils/dist/jszip-utils.js");
100
101    /** The name of the default jszip-utils javascript file. */
102    public static final DocPath JSZIPUTILS_MIN = DocPath.create("jszip-utils/dist/jszip-utils.min.js");
103
104    /** The name of the default jszip-utils javascript file. */
105    public static final DocPath JSZIPUTILS_IE = DocPath.create("jszip-utils/dist/jszip-utils-ie.js");
106
107    /** The name of the default jszip-utils javascript file. */
108    public static final DocPath JSZIPUTILS_IE_MIN = DocPath.create("jszip-utils/dist/jszip-utils-ie.min.js");
109
110    /** The name of the member search index file. */
111    public static final DocPath MEMBER_SEARCH_INDEX_JSON = DocPath.create("member-search-index.json");
112
113    /** The name of the member search index zip file. */
114    public static final DocPath MEMBER_SEARCH_INDEX_ZIP = DocPath.create("member-search-index.zip");
115
116    /** The name of the file for the overview frame. */
117    public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
118
119    /** The name of the file for the overview summary. */
120    public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
121
122    /** The name of the file for the overview tree. */
123    public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
124
125    /** The name of the file for the package frame. */
126    public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html");
127
128    /** The name of the file for the package list. */
129    public static final DocPath PACKAGE_LIST = DocPath.create("package-list");
130
131    /** The name of the package search index file. */
132    public static final DocPath PACKAGE_SEARCH_INDEX_JSON = DocPath.create("package-search-index.json");
133
134    /** The name of the package search index zipfile. */
135    public static final DocPath PACKAGE_SEARCH_INDEX_ZIP = DocPath.create("package-search-index.zip");
136
137    /** The name of the file for the package summary. */
138    public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html");
139
140    /** The name of the file for the package tree. */
141    public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html");
142
143    /** The name of the file for the package usage info. */
144    public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
145
146    /** The name of the sub-package from which resources are read. */
147    public static final DocPath RESOURCES = DocPath.create("resources");
148
149    /** The name of the search javascript file. */
150    public static final DocPath SEARCH_JS = DocPath.create("search.js");
151
152    /** The name of the file for the serialized form info. */
153    public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
154
155    /** The name of the directory in which HTML versions of the source code
156     *  are generated.
157     */
158    public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
159
160    /** The name of the default stylesheet. */
161    public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
162
163    /** The name of the tag search index file. */
164    public static final DocPath TAG_SEARCH_INDEX_JSON = DocPath.create("tag-search-index.json");
165
166    /** The name of the tag search index zip file. */
167    public static final DocPath TAG_SEARCH_INDEX_ZIP = DocPath.create("tag-search-index.zip");
168
169    /** The name of the type search index file. */
170    public static final DocPath TYPE_SEARCH_INDEX_JSON = DocPath.create("type-search-index.json");
171
172    /** The name of the type search index zip file. */
173    public static final DocPath TYPE_SEARCH_INDEX_ZIP = DocPath.create("type-search-index.zip");
174
175    /** The name of the image file for undo button on the search box. */
176    public static final DocPath X_IMG = DocPath.create("x.png");
177
178}
179