jjg@1372: /* bpatel@1568: * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. jjg@1372: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. jjg@1372: * jjg@1372: * This code is free software; you can redistribute it and/or modify it jjg@1372: * under the terms of the GNU General Public License version 2 only, as jjg@1372: * published by the Free Software Foundation. Oracle designates this jjg@1372: * particular file as subject to the "Classpath" exception as provided jjg@1372: * by Oracle in the LICENSE file that accompanied this code. jjg@1372: * jjg@1372: * This code is distributed in the hope that it will be useful, but WITHOUT jjg@1372: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or jjg@1372: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License jjg@1372: * version 2 for more details (a copy is included in the LICENSE file that jjg@1372: * accompanied this code). jjg@1372: * jjg@1372: * You should have received a copy of the GNU General Public License version jjg@1372: * 2 along with this work; if not, write to the Free Software Foundation, jjg@1372: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. jjg@1372: * jjg@1372: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA jjg@1372: * or visit www.oracle.com if you need additional information or have any jjg@1372: * questions. jjg@1372: */ jjg@1372: jjg@1372: package com.sun.tools.doclets.internal.toolkit.util; jjg@1372: jjg@1372: /** jjg@1372: * Standard DocPath objects. jjg@1372: * jjg@1383: *

This is NOT part of any supported API. jjg@1383: * If you write code that depends on this, you do so at your own risk. jjg@1383: * This code and its internal interfaces are subject to change or jjg@1383: * deletion without notice. jjg@1383: * jjg@1372: * @since 8 jjg@1372: */ jjg@1372: public class DocPaths { jjg@1372: jjg@1372: /** The name of the file for all classes, using frames. */ jjg@1372: public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html"); jjg@1372: jjg@1372: /** The name of the file for all classes, without using frames. */ jjg@1372: public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html"); jjg@1372: jjg@1372: /** The name of the sub-directory for storing class usage info. */ jjg@1372: public static final DocPath CLASS_USE = DocPath.create("class-use"); jjg@1372: jjg@1372: /** The name of the file for constant values. */ jjg@1372: public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html"); jjg@1372: jjg@1372: /** The name of the fie for deprecated elements. */ jjg@1372: public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html"); jjg@1372: jjg@1372: /** The name of the subdirectory for user-provided additional documentation files. */ jjg@1372: public static final DocPath DOC_FILES = DocPath.create("doc-files"); jjg@1372: jjg@1372: /** The name of the file for help info. */ jjg@1372: public static final DocPath HELP_DOC = DocPath.create("help-doc.html"); jjg@1372: jjg@1372: /** The name of the main index file. */ jjg@1372: public static final DocPath INDEX = DocPath.create("index.html"); jjg@1372: jjg@1372: /** The name of the single index file for all classes. */ jjg@1372: public static final DocPath INDEX_ALL = DocPath.create("index-all.html"); jjg@1372: jjg@1372: /** The name of the directory for the split index files. */ jjg@1372: public static final DocPath INDEX_FILES = DocPath.create("index-files"); jjg@1372: jjg@1372: /** Generate the name of one of the files in the split index. */ jjg@1372: public static final DocPath indexN(int n) { jjg@1372: return DocPath.create("index-" + n + ".html"); jjg@1372: } jjg@1372: bpatel@1417: /** The name of the default javascript file. */ bpatel@1417: public static final DocPath JAVASCRIPT = DocPath.create("script.js"); bpatel@1417: jjg@1372: /** The name of the file for the overview frame. */ jjg@1372: public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html"); jjg@1372: jjg@1372: /** The name of the file for the overview summary. */ jjg@1372: public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html"); jjg@1372: jjg@1372: /** The name of the file for the overview tree. */ jjg@1372: public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html"); jjg@1372: jjg@1372: /** The name of the file for the package frame. */ jjg@1372: public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html"); jjg@1372: bpatel@1568: /** The name of the file for the profile frame. */ bpatel@1568: public static final DocPath profileFrame(String profileName) { bpatel@1568: return DocPath.create(profileName + "-frame.html"); bpatel@1568: } bpatel@1568: bpatel@1568: /** The name of the file for the profile package frame. */ bpatel@1568: public static final DocPath profilePackageFrame(String profileName) { bpatel@1568: return DocPath.create(profileName + "-package-frame.html"); bpatel@1568: } bpatel@1568: bpatel@1568: /** The name of the file for the profile package summary. */ bpatel@1568: public static final DocPath profilePackageSummary(String profileName) { bpatel@1568: return DocPath.create(profileName + "-package-summary.html"); bpatel@1568: } bpatel@1568: bpatel@1568: /** The name of the file for the profile summary. */ bpatel@1568: public static final DocPath profileSummary(String profileName) { bpatel@1568: return DocPath.create(profileName + "-summary.html"); bpatel@1568: } bpatel@1568: jjg@1372: /** The name of the file for the package list. */ jjg@1372: public static final DocPath PACKAGE_LIST = DocPath.create("package-list"); jjg@1372: jjg@1372: /** The name of the file for the package summary. */ jjg@1372: public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html"); jjg@1372: jjg@1372: /** The name of the file for the package tree. */ jjg@1372: public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html"); jjg@1372: jjg@1372: /** The name of the file for the package usage info. */ jjg@1372: public static final DocPath PACKAGE_USE = DocPath.create("package-use.html"); jjg@1372: bpatel@1568: /** The name of the file for the overview frame. */ bpatel@1568: public static final DocPath PROFILE_OVERVIEW_FRAME = DocPath.create("profile-overview-frame.html"); bpatel@1568: jjg@1372: /** The name of the directory in which resources are generated. jjg@1372: * Also the name of the sub-package from which resources are read. jjg@1372: */ jjg@1372: public static final DocPath RESOURCES = DocPath.create("resources"); jjg@1372: jjg@1372: /** The name of the file for the serialized form info. */ jjg@1372: public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html"); jjg@1372: jjg@1372: /** The name of the directory in which HTML versions of the source code jjg@1372: * are generated. jjg@1372: */ jjg@1372: public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html"); jjg@1372: jjg@1372: /** The name of the default stylesheet. */ jjg@1372: public static final DocPath STYLESHEET = DocPath.create("stylesheet.css"); jjg@1372: jjg@1372: }