messages.java

OpenCms 是一个J2EE的产品

/*
 * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/workflow/Messages.java,v $
 * Date   : $Date: 2006/03/28 12:14:36 $
 * Version: $Revision: 1.10 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Mananagement System
 *
 * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.workflow;

import org.opencms.file.CmsRequestContext;
import org.opencms.i18n.A_CmsMessageBundle;
import org.opencms.i18n.CmsLocaleManager;
import org.opencms.i18n.I_CmsMessageBundle;

import java.util.Locale;

/**
 * Convenience class to access the localized messages of this OpenCms package.<p> 
 * 
 * @author Achim Westermann 
 * 
 * @version $Revision: 1.10 $ 
 * 
 * @since 6.0.0 
 */
public final class Messages extends A_CmsMessageBundle {

    /** Message constant for key in the resource bundle. */
    public static final String ERR_BAD_TASKNAME_4 = "ERR_BAD_TASKNAME_4";

    /** Message constant for key in the resource bundle. */
    public static final String ERR_BAD_TASKNAME_EMPTY_0 = "ERR_BAD_TASKNAME_EMPTY_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_ENDED_0 = "GUI_TASK_STATE_ENDED_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_HALTED_0 = "GUI_TASK_STATE_HALTED_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_PREPARED_0 = "GUI_TASK_STATE_PREPARED_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_RUNNING_0 = "GUI_TASK_STATE_RUNNING_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_START_0 = "GUI_TASK_STATE_START_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_STARTED_0 = "GUI_TASK_STATE_STARTED_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_STATE_UNKNOWN_0 = "GUI_TASK_STATE_UNKNOWN_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_TYPE_ACTIVE_0 = "GUI_TASK_TYPE_ACTIVE_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_TYPE_ALL_0 = "GUI_TASK_TYPE_ALL_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_TYPE_DONE_0 = "GUI_TASK_TYPE_DONE_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_TYPE_ILLEGAL_0 = "GUI_TASK_TYPE_ILLEGAL_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_TYPE_NEW_0 = "GUI_TASK_TYPE_NEW_0";

    /** Message constant for key in the resource bundle. */
    public static final String GUI_TASK_TYPE_OPEN_0 = "GUI_TASK_TYPE_OPEN_0";

    /** Name of the used resource bundle. */
    private static final String BUNDLE_NAME = "org.opencms.workflow.messages";

    /** Static instance member. */
    private static final I_CmsMessageBundle INSTANCE = new Messages();

    /**
     * Hides the public constructor for this utility class.<p>
     */
    private Messages() {

        // hide the constructor
    }

    /**
     * Returns an instance of this localized message accessor.<p>
     * 
     * @return an instance of this localized message accessor
     */
    public static I_CmsMessageBundle get() {

        return INSTANCE;
    }

    /**
     * Small utility-method that allows output of task states in the OpenCms default locale. <p>
     * 
     * @param taskType One of 
     * <ul>
     *  <li>
     *   {@link CmsTaskService#TASKS_ACTIVE}
     *  <li>
     *   {@link CmsTaskService#TASKS_ALL}
     *  <li>
     *   {@link CmsTaskService#TASKS_DONE}
     *  <li>
     *   {@link CmsTaskService#TASKS_NEW}
     *  <li> 
     *   {@link CmsTaskService#TASKS_OPEN}
     * </ul>
     * @return A string describing the state of the task in the default locale.
     * @see CmsTaskService
     * @see #toTaskTypeString(int, CmsRequestContext)
     */
    public static String toTaskTypeString(int taskType) {

        return toTaskTypeString(taskType, CmsLocaleManager.getDefaultLocale());
    }

    /**
     * Small utility-method that allows output of task states in the locale of the current user request. <p>
     * 
     * @param taskType One of 
     * <ul>
     *  <li>
     *   {@link CmsTaskService#TASKS_ACTIVE}
     *  <li>
     *   {@link CmsTaskService#TASKS_ALL}
     *  <li>
     *   {@link CmsTaskService#TASKS_DONE}
     *  <li>
     *   {@link CmsTaskService#TASKS_NEW}
     *  <li> 
     *   {@link CmsTaskService#TASKS_OPEN}
     * </ul>
     * 
     * @param context the current user's request context. 
     * @return A string describing the state of the task in the default locale.
     * @see CmsTaskService 
     * @see #toTaskTypeString(int)
     */

    public static String toTaskTypeString(int taskType, CmsRequestContext context) {

        return toTaskTypeString(taskType, context.getLocale());
    }

    /**
     * Small utility-method that allows output of task states in the given <code>Locale</code>. <p>
     * 
     * @param taskType One of 
     * <ul>
     *  <li>
     *   {@link CmsTaskService#TASKS_ACTIVE}
     *  <li>
     *   {@link CmsTaskService#TASKS_ALL}
     *  <li>
     *   {@link CmsTaskService#TASKS_DONE}
     *  <li>
     *   {@link CmsTaskService#TASKS_NEW}
     *  <li> 
     *   {@link CmsTaskService#TASKS_OPEN}
     * </ul>
     * @param locale the locale in which the task state should be given back. 
     * @return A string describing the state of the task in the default locale.
     * @see CmsTaskService 
     * @see #toTaskTypeString(int)
     */
    public static String toTaskTypeString(int taskType, Locale locale) {

        switch (taskType) {
            case CmsTaskService.TASKS_ACTIVE:
                return Messages.get().getBundle(locale).key(Messages.GUI_TASK_TYPE_ACTIVE_0);
            case CmsTaskService.TASKS_ALL:
                return Messages.get().getBundle(locale).key(Messages.GUI_TASK_TYPE_ACTIVE_0);
            case CmsTaskService.TASKS_DONE:
                return Messages.get().getBundle(locale).key(Messages.GUI_TASK_TYPE_ACTIVE_0);
            case CmsTaskService.TASKS_NEW:
                return Messages.get().getBundle(locale).key(Messages.GUI_TASK_TYPE_ACTIVE_0);
            case CmsTaskService.TASKS_OPEN:
            default:
                return Messages.get().getBundle(locale).key(Messages.GUI_TASK_TYPE_ILLEGAL_0);
        }
    }

    /**
     * Returns the bundle name for this OpenCms package.<p>
     * 
     * @return the bundle name for this OpenCms package
     */
    public String getBundleName() {

        return BUNDLE_NAME;
    }

}