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