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

Thu, 15 Nov 2012 19:54:20 -0800

author
jjg
date
Thu, 15 Nov 2012 19:54:20 -0800
changeset 1412
400a4e8accd3
parent 1383
b980e8e6aabf
child 1417
522a1ee72340
permissions
-rw-r--r--

8002079: update DocFile to use a JavaFileManager
Reviewed-by: darcy

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

mercurial