author | asaha |
Tue, 14 Jan 2014 08:08:32 -0800 | |
changeset 22449 | 1fd6d4bec7dd |
parent 22163 | 3651128c74eb |
parent 22447 | 364fe5d83775 |
permissions | -rw-r--r-- |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
1 |
/* |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
2 |
* Copyright (c) 1998, 2013, 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 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
26 |
package com.sun.tools.doclets.internal.toolkit.util; |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
27 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
28 |
/** |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
29 |
* Standard DocPath objects. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
30 |
* |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
31 |
* <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
|
32 |
* 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
|
33 |
* 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
|
34 |
* deletion without notice.</b> |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
35 |
* |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
36 |
* @since 8 |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
37 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
38 |
public class DocPaths { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
39 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
40 |
/** 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
|
41 |
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
|
42 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
43 |
/** 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
|
44 |
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
|
45 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
46 |
/** 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
|
47 |
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
|
48 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
49 |
/** The name of the file for constant values. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
50 |
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
|
51 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
52 |
/** The name of the fie for deprecated elements. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
53 |
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
|
54 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
55 |
/** 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
|
56 |
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
|
57 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
58 |
/** The name of the file for help info. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
59 |
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
|
60 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
61 |
/** The name of the main index file. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
62 |
public static final DocPath INDEX = DocPath.create("index.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
63 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
64 |
/** 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
|
65 |
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
|
66 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
67 |
/** 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
|
68 |
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
|
69 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
70 |
/** Generate the name of one of the files in the split index. */ |
22163 | 71 |
public static DocPath indexN(int n) { |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
72 |
return DocPath.create("index-" + n + ".html"); |
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 |
|
14549
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14368
diff
changeset
|
75 |
/** The name of the default javascript file. */ |
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14368
diff
changeset
|
76 |
public static final DocPath JAVASCRIPT = DocPath.create("script.js"); |
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14368
diff
changeset
|
77 |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
78 |
/** The name of the file for the overview frame. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
79 |
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
|
80 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
81 |
/** The name of the file for the overview summary. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
82 |
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
|
83 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
84 |
/** The name of the file for the overview tree. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
85 |
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
|
86 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
87 |
/** The name of the file for the package frame. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
88 |
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
|
89 |
|
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
90 |
/** The name of the file for the profile frame. */ |
22163 | 91 |
public static DocPath profileFrame(String profileName) { |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
92 |
return DocPath.create(profileName + "-frame.html"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
93 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
94 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
95 |
/** The name of the file for the profile package frame. */ |
22163 | 96 |
public static DocPath profilePackageFrame(String profileName) { |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
97 |
return DocPath.create(profileName + "-package-frame.html"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
98 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
99 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
100 |
/** The name of the file for the profile package summary. */ |
22163 | 101 |
public static DocPath profilePackageSummary(String profileName) { |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
102 |
return DocPath.create(profileName + "-package-summary.html"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
103 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
104 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
105 |
/** The name of the file for the profile summary. */ |
22163 | 106 |
public static DocPath profileSummary(String profileName) { |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
107 |
return DocPath.create(profileName + "-summary.html"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
108 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
109 |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
110 |
/** The name of the file for the package list. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
111 |
public static final DocPath PACKAGE_LIST = DocPath.create("package-list"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
112 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
113 |
/** The name of the file for the package summary. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
114 |
public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
115 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
116 |
/** The name of the file for the package tree. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
117 |
public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
118 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
119 |
/** The name of the file for the package usage info. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
120 |
public static final DocPath PACKAGE_USE = DocPath.create("package-use.html"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
121 |
|
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
122 |
/** The name of the file for the overview frame. */ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
123 |
public static final DocPath PROFILE_OVERVIEW_FRAME = DocPath.create("profile-overview-frame.html"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
14549
diff
changeset
|
124 |
|
22447 | 125 |
/** 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
|
126 |
public static final DocPath RESOURCES = DocPath.create("resources"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
127 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
128 |
/** 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
|
129 |
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
|
130 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
131 |
/** 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
|
132 |
* are generated. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
133 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
134 |
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
|
135 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
136 |
/** The name of the default stylesheet. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
137 |
public static final DocPath STYLESHEET = DocPath.create("stylesheet.css"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
138 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
139 |
} |