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

changeset 1
9a66ca7c79fa
child 554
9d9f26857129
     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/DocletConstants.java	Sat Dec 01 00:00:00 2007 +0000
     1.3 @@ -0,0 +1,85 @@
     1.4 +/*
     1.5 + * Copyright 2003-2004 Sun Microsystems, Inc.  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.  Sun designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
    1.26 + * have any questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.tools.doclets.internal.toolkit.util;
    1.30 +
    1.31 +/**
    1.32 + * Stores all constants for a Doclet.  Extend this class if you have doclet
    1.33 + * specific constants to add.
    1.34 + *
    1.35 + * This code is not part of an API.
    1.36 + * It is implementation that is subject to change.
    1.37 + * Do not use it as an API
    1.38 + *
    1.39 + * @author Jamie Ho
    1.40 + * @since 1.5
    1.41 + */
    1.42 +public class DocletConstants {
    1.43 +
    1.44 +    /**
    1.45 +     * The default package name.
    1.46 +     */
    1.47 +    public static final String DEFAULT_PACKAGE_NAME = "<Unnamed>";
    1.48 +
    1.49 +    /**
    1.50 +     * The default package file name.
    1.51 +     */
    1.52 +    public static final String DEFAULT_PACKAGE_FILE_NAME = "default";
    1.53 +
    1.54 +    /**
    1.55 +     * The anchor for the default package.
    1.56 +     */
    1.57 +    public static final String UNNAMED_PACKAGE_ANCHOR = "unnamed_package";
    1.58 +
    1.59 +    /**
    1.60 +     * The name of the doc files directory.
    1.61 +     */
    1.62 +    public static final String DOC_FILES_DIR_NAME = "doc-files";
    1.63 +
    1.64 +    /**
    1.65 +     * The default amount of space between tab stops.
    1.66 +     */
    1.67 +    public static final int DEFAULT_TAB_STOP_LENGTH = 8;
    1.68 +
    1.69 +    /**
    1.70 +     * The name of the directory where we will copy resource files to.
    1.71 +     */
    1.72 +    public static final String RESOURE_DIR_NAME = "resources";
    1.73 +
    1.74 +    /**
    1.75 +     * The source output directory name
    1.76 +     */
    1.77 +    public static final String SOURCE_OUTPUT_DIR_NAME = "src-html/";
    1.78 +
    1.79 +    /**
    1.80 +     * The name of the package list file.
    1.81 +     */
    1.82 +    public static final String PACKAGE_LIST_FILE_NAME = "package-list";
    1.83 +
    1.84 +    /**
    1.85 +     * The line seperator for the current operating system.
    1.86 +     */
    1.87 +    public static final String NL = System.getProperty("line.separator");
    1.88 +}

mercurial