• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPaths.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPaths.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 2225

b8ebde062692

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.internal.toolkit.util;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Standard DocPath objects.
aoqi@0	30	*
aoqi@0	31	* <p><b>This is NOT part of any supported API.
aoqi@0	32	* If you write code that depends on this, you do so at your own risk.
aoqi@0	33	* This code and its internal interfaces are subject to change or
aoqi@0	34	* deletion without notice.</b>
aoqi@0	35	*
aoqi@0	36	* @since 8
aoqi@0	37	*/
aoqi@0	38	public class DocPaths {
aoqi@0	39
aoqi@0	40	/** The name of the file for all classes, using frames. */
aoqi@0	41	public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html");
aoqi@0	42
aoqi@0	43	/** The name of the file for all classes, without using frames. */
aoqi@0	44	public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html");
aoqi@0	45
aoqi@0	46	/** The name of the sub-directory for storing class usage info. */
aoqi@0	47	public static final DocPath CLASS_USE = DocPath.create("class-use");
aoqi@0	48
aoqi@0	49	/** The name of the file for constant values. */
aoqi@0	50	public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html");
aoqi@0	51
aoqi@0	52	/** The name of the fie for deprecated elements. */
aoqi@0	53	public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
aoqi@0	54
aoqi@0	55	/** The name of the subdirectory for user-provided additional documentation files. */
aoqi@0	56	public static final DocPath DOC_FILES = DocPath.create("doc-files");
aoqi@0	57
aoqi@0	58	/** The name of the file for help info. */
aoqi@0	59	public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
aoqi@0	60
aoqi@0	61	/** The name of the main index file. */
aoqi@0	62	public static final DocPath INDEX = DocPath.create("index.html");
aoqi@0	63
aoqi@0	64	/** The name of the single index file for all classes. */
aoqi@0	65	public static final DocPath INDEX_ALL = DocPath.create("index-all.html");
aoqi@0	66
aoqi@0	67	/** The name of the directory for the split index files. */
aoqi@0	68	public static final DocPath INDEX_FILES = DocPath.create("index-files");
aoqi@0	69
aoqi@0	70	/** Generate the name of one of the files in the split index. */
aoqi@0	71	public static final DocPath indexN(int n) {
aoqi@0	72	return DocPath.create("index-" + n + ".html");
aoqi@0	73	}
aoqi@0	74
aoqi@0	75	/** The name of the default javascript file. */
aoqi@0	76	public static final DocPath JAVASCRIPT = DocPath.create("script.js");
aoqi@0	77
aoqi@0	78	/** The name of the file for the overview frame. */
aoqi@0	79	public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
aoqi@0	80
aoqi@0	81	/** The name of the file for the overview summary. */
aoqi@0	82	public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
aoqi@0	83
aoqi@0	84	/** The name of the file for the overview tree. */
aoqi@0	85	public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
aoqi@0	86
aoqi@0	87	/** The name of the file for the package frame. */
aoqi@0	88	public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html");
aoqi@0	89
aoqi@0	90	/** The name of the file for the profile frame. */
aoqi@0	91	public static final DocPath profileFrame(String profileName) {
aoqi@0	92	return DocPath.create(profileName + "-frame.html");
aoqi@0	93	}
aoqi@0	94
aoqi@0	95	/** The name of the file for the profile package frame. */
aoqi@0	96	public static final DocPath profilePackageFrame(String profileName) {
aoqi@0	97	return DocPath.create(profileName + "-package-frame.html");
aoqi@0	98	}
aoqi@0	99
aoqi@0	100	/** The name of the file for the profile package summary. */
aoqi@0	101	public static final DocPath profilePackageSummary(String profileName) {
aoqi@0	102	return DocPath.create(profileName + "-package-summary.html");
aoqi@0	103	}
aoqi@0	104
aoqi@0	105	/** The name of the file for the profile summary. */
aoqi@0	106	public static final DocPath profileSummary(String profileName) {
aoqi@0	107	return DocPath.create(profileName + "-summary.html");
aoqi@0	108	}
aoqi@0	109
aoqi@0	110	/** The name of the file for the package list. */
aoqi@0	111	public static final DocPath PACKAGE_LIST = DocPath.create("package-list");
aoqi@0	112
aoqi@0	113	/** The name of the file for the package summary. */
aoqi@0	114	public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html");
aoqi@0	115
aoqi@0	116	/** The name of the file for the package tree. */
aoqi@0	117	public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html");
aoqi@0	118
aoqi@0	119	/** The name of the file for the package usage info. */
aoqi@0	120	public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
aoqi@0	121
aoqi@0	122	/** The name of the file for the overview frame. */
aoqi@0	123	public static final DocPath PROFILE_OVERVIEW_FRAME = DocPath.create("profile-overview-frame.html");
aoqi@0	124
aoqi@0	125	/** The name of the sub-package from which resources are read. */
aoqi@0	126	public static final DocPath RESOURCES = DocPath.create("resources");
aoqi@0	127
aoqi@0	128	/** The name of the file for the serialized form info. */
aoqi@0	129	public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
aoqi@0	130
aoqi@0	131	/** The name of the directory in which HTML versions of the source code
aoqi@0	132	* are generated.
aoqi@0	133	*/
aoqi@0	134	public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
aoqi@0	135
aoqi@0	136	/** The name of the default stylesheet. */
aoqi@0	137	public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
aoqi@0	138
aoqi@0	139	}