1 /*
2 * Copyright (c) 1998, 2012, 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
26 package com.sun.tools.doclets.internal.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 * @since 8
37 */
38 public class DocPaths {
39
40 /** The name of the file for all classes, using frames. */
41 public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html");
42
43 /** The name of the file for all classes, without using frames. */
44 public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html");
45
46 /** The name of the sub-directory for storing class usage info. */
47 public static final DocPath CLASS_USE = DocPath.create("class-use");
48
49 /** The name of the file for constant values. */
50 public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html");
51
52 /** The name of the fie for deprecated elements. */
53 public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
54
55 /** The name of the subdirectory for user-provided additional documentation files. */
56 public static final DocPath DOC_FILES = DocPath.create("doc-files");
57
58 /** The name of the file for help info. */
59 public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
60
61 /** The name of the main index file. */
62 public static final DocPath INDEX = DocPath.create("index.html");
63
64 /** The name of the single index file for all classes. */
65 public static final DocPath INDEX_ALL = DocPath.create("index-all.html");
66
67 /** The name of the directory for the split index files. */
68 public static final DocPath INDEX_FILES = DocPath.create("index-files");
69
70 /** Generate the name of one of the files in the split index. */
71 public static final DocPath indexN(int n) {
72 return DocPath.create("index-" + n + ".html");
73 }
74
75 /** The name of the default javascript file. */
76 public static final DocPath JAVASCRIPT = DocPath.create("script.js");
77
78 /** The name of the file for the overview frame. */
79 public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
80
81 /** The name of the file for the overview summary. */
82 public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
83
84 /** The name of the file for the overview tree. */
85 public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
86
87 /** The name of the file for the package frame. */
88 public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html");
89
90 /** The name of the file for the package list. */
91 public static final DocPath PACKAGE_LIST = DocPath.create("package-list");
92
93 /** The name of the file for the package summary. */
94 public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html");
95
96 /** The name of the file for the package tree. */
97 public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html");
98
99 /** The name of the file for the package usage info. */
100 public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
101
102 /** The name of the directory in which resources are generated.
103 * Also the name of the sub-package from which resources are read.
104 */
105 public static final DocPath RESOURCES = DocPath.create("resources");
106
107 /** The name of the file for the serialized form info. */
108 public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
109
110 /** The name of the directory in which HTML versions of the source code
111 * are generated.
112 */
113 public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
114
115 /** The name of the default stylesheet. */
116 public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
117
118 }