001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.publish;
029
030import org.opencms.util.A_CmsModeStringEnumeration;
031
032/**
033 * Class defining the publish engine states.<p>
034 *
035 * @since 6.9.1
036 */
037public final class CmsPublishEngineState extends A_CmsModeStringEnumeration {
038
039    /** State indicating that engine is not acceptiong publish jobs. */
040    public static final CmsPublishEngineState ENGINE_DISABLED = new CmsPublishEngineState("disabled");
041
042    /** State indicating that engine is acceptiong and processing publish jobs. */
043    public static final CmsPublishEngineState ENGINE_STARTED = new CmsPublishEngineState("started");
044
045    /** State indicating that engine is accepting but not processing publish jobs. */
046    public static final CmsPublishEngineState ENGINE_STOPPED = new CmsPublishEngineState("stopped");
047
048    /** The serial version id. */
049    private static final long serialVersionUID = 4860148946570407490L;
050
051    /**
052     * Private constructor.<p>
053     *
054     * @param state the state description
055     */
056    private CmsPublishEngineState(String state) {
057
058        super(state);
059    }
060}