1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPaths.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,139 @@
1.4 +/*
1.5 + * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit.util;
1.30 +
1.31 +/**
1.32 + * Standard DocPath objects.
1.33 + *
1.34 + * <p><b>This is NOT part of any supported API.
1.35 + * If you write code that depends on this, you do so at your own risk.
1.36 + * This code and its internal interfaces are subject to change or
1.37 + * deletion without notice.</b>
1.38 + *
1.39 + * @since 8
1.40 + */
1.41 +public class DocPaths {
1.42 +
1.43 + /** The name of the file for all classes, using frames. */
1.44 + public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html");
1.45 +
1.46 + /** The name of the file for all classes, without using frames. */
1.47 + public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html");
1.48 +
1.49 + /** The name of the sub-directory for storing class usage info. */
1.50 + public static final DocPath CLASS_USE = DocPath.create("class-use");
1.51 +
1.52 + /** The name of the file for constant values. */
1.53 + public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html");
1.54 +
1.55 + /** The name of the fie for deprecated elements. */
1.56 + public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
1.57 +
1.58 + /** The name of the subdirectory for user-provided additional documentation files. */
1.59 + public static final DocPath DOC_FILES = DocPath.create("doc-files");
1.60 +
1.61 + /** The name of the file for help info. */
1.62 + public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
1.63 +
1.64 + /** The name of the main index file. */
1.65 + public static final DocPath INDEX = DocPath.create("index.html");
1.66 +
1.67 + /** The name of the single index file for all classes. */
1.68 + public static final DocPath INDEX_ALL = DocPath.create("index-all.html");
1.69 +
1.70 + /** The name of the directory for the split index files. */
1.71 + public static final DocPath INDEX_FILES = DocPath.create("index-files");
1.72 +
1.73 + /** Generate the name of one of the files in the split index. */
1.74 + public static final DocPath indexN(int n) {
1.75 + return DocPath.create("index-" + n + ".html");
1.76 + }
1.77 +
1.78 + /** The name of the default javascript file. */
1.79 + public static final DocPath JAVASCRIPT = DocPath.create("script.js");
1.80 +
1.81 + /** The name of the file for the overview frame. */
1.82 + public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
1.83 +
1.84 + /** The name of the file for the overview summary. */
1.85 + public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
1.86 +
1.87 + /** The name of the file for the overview tree. */
1.88 + public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
1.89 +
1.90 + /** The name of the file for the package frame. */
1.91 + public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html");
1.92 +
1.93 + /** The name of the file for the profile frame. */
1.94 + public static final DocPath profileFrame(String profileName) {
1.95 + return DocPath.create(profileName + "-frame.html");
1.96 + }
1.97 +
1.98 + /** The name of the file for the profile package frame. */
1.99 + public static final DocPath profilePackageFrame(String profileName) {
1.100 + return DocPath.create(profileName + "-package-frame.html");
1.101 + }
1.102 +
1.103 + /** The name of the file for the profile package summary. */
1.104 + public static final DocPath profilePackageSummary(String profileName) {
1.105 + return DocPath.create(profileName + "-package-summary.html");
1.106 + }
1.107 +
1.108 + /** The name of the file for the profile summary. */
1.109 + public static final DocPath profileSummary(String profileName) {
1.110 + return DocPath.create(profileName + "-summary.html");
1.111 + }
1.112 +
1.113 + /** The name of the file for the package list. */
1.114 + public static final DocPath PACKAGE_LIST = DocPath.create("package-list");
1.115 +
1.116 + /** The name of the file for the package summary. */
1.117 + public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html");
1.118 +
1.119 + /** The name of the file for the package tree. */
1.120 + public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html");
1.121 +
1.122 + /** The name of the file for the package usage info. */
1.123 + public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
1.124 +
1.125 + /** The name of the file for the overview frame. */
1.126 + public static final DocPath PROFILE_OVERVIEW_FRAME = DocPath.create("profile-overview-frame.html");
1.127 +
1.128 + /** The name of the sub-package from which resources are read. */
1.129 + public static final DocPath RESOURCES = DocPath.create("resources");
1.130 +
1.131 + /** The name of the file for the serialized form info. */
1.132 + public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
1.133 +
1.134 + /** The name of the directory in which HTML versions of the source code
1.135 + * are generated.
1.136 + */
1.137 + public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
1.138 +
1.139 + /** The name of the default stylesheet. */
1.140 + public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
1.141 +
1.142 +}
