001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH (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, 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.main;
029
030/**
031 * Wrapper exception used to notify the shell that an error has occurred during execution of a shell command.<p>
032 */
033public class CmsShellCommandException extends RuntimeException {
034
035    /** Serial version id. */
036    private static final long serialVersionUID = 5501584058087027184L;
037
038    /** Indicates whether this exception was created because of a report error. */
039    private boolean m_fromReport;
040
041    /**
042     * Creates a new instance.<p>
043     *
044     * @param fromReport true if this exception is being created because of a report error
045     */
046    public CmsShellCommandException(boolean fromReport) {
047        super("Shell command exception caused by report error");
048        m_fromReport = fromReport;
049    }
050
051    /**
052     * Creates a new instance.<p>
053     *
054     * @param t the cause of this exception
055     */
056    public CmsShellCommandException(Throwable t) {
057        super("Shell command exception caused by different exception", t);
058    }
059
060    /**
061     * Returns true if this exception was created because of a report error.<p>
062     *
063     * @return true if this exception was created because of a report error
064     */
065    public boolean isFromReport() {
066
067        return m_fromReport;
068    }
069
070}