001    /*
002     * Copyright 2003-2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.tools.doclets.internal.toolkit.util;
027    
028    /**
029     * Stores all constants for a Doclet.  Extend this class if you have doclet
030     * specific constants to add.
031     *
032     * This code is not part of an API.
033     * It is implementation that is subject to change.
034     * Do not use it as an API
035     *
036     * @author Jamie Ho
037     * @since 1.5
038     */
039    public class DocletConstants {
040    
041        /**
042         * The default package name.
043         */
044        public static final String DEFAULT_PACKAGE_NAME = "<Unnamed>";
045    
046        /**
047         * The default package file name.
048         */
049        public static final String DEFAULT_PACKAGE_FILE_NAME = "default";
050    
051        /**
052         * The anchor for the default package.
053         */
054        public static final String UNNAMED_PACKAGE_ANCHOR = "unnamed_package";
055    
056        /**
057         * The name of the doc files directory.
058         */
059        public static final String DOC_FILES_DIR_NAME = "doc-files";
060    
061        /**
062         * The default amount of space between tab stops.
063         */
064        public static final int DEFAULT_TAB_STOP_LENGTH = 8;
065    
066        /**
067         * The name of the directory where we will copy resource files to.
068         */
069        public static final String RESOURE_DIR_NAME = "resources";
070    
071        /**
072         * The source output directory name
073         */
074        public static final String SOURCE_OUTPUT_DIR_NAME = "src-html/";
075    
076        /**
077         * The name of the package list file.
078         */
079        public static final String PACKAGE_LIST_FILE_NAME = "package-list";
080    
081        /**
082         * The line seperator for the current operating system.
083         */
084        public static final String NL = System.getProperty("line.separator");
085    }