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.widgets;
029
030import org.opencms.i18n.CmsMessageContainer;
031import org.opencms.main.CmsException;
032
033/**
034 * Describes errors that occur in the context of the OpenCms widgets.<p>
035 *
036 * @since 6.0.0
037 */
038public class CmsWidgetException extends CmsException {
039
040    /** Serial version UID required for safe serialization. */
041    private static final long serialVersionUID = -7003923645953106868L;
042
043    /** The widget that caused the error. */
044    private transient Object m_widget;
045
046    /**
047     * Creates a new localized Exception.<p>
048     *
049     * @param container the localized message container to use
050     */
051    public CmsWidgetException(CmsMessageContainer container) {
052
053        this(container, null, null);
054    }
055
056    /**
057     * Creates a new localized Exception.<p>
058     *
059     * @param container the localized message container to use
060     * @param widget the widget that caused the error
061     */
062    public CmsWidgetException(CmsMessageContainer container, Object widget) {
063
064        super(container);
065        m_widget = widget;
066    }
067
068    /**
069     * Creates a new localized Exception that also containes a root cause.<p>
070     *
071     * @param container the localized message container to use
072     * @param cause the Exception root cause
073     */
074    public CmsWidgetException(CmsMessageContainer container, Throwable cause) {
075
076        this(container, cause, null);
077    }
078
079    /**
080     * Creates a new localized Exception that also containes a root cause.<p>
081     *
082     * @param container the localized message container to use
083     * @param cause the Exception root cause
084     * @param widget the widget that caused the error
085     */
086    public CmsWidgetException(CmsMessageContainer container, Throwable cause, Object widget) {
087
088        super(container, cause);
089        m_widget = widget;
090    }
091
092    /**
093     * @see org.opencms.main.CmsException#createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)
094     */
095    @Override
096    public CmsException createException(CmsMessageContainer container, Throwable cause) {
097
098        if (cause instanceof CmsWidgetException) {
099            return new CmsWidgetException(container, cause, ((CmsWidgetException)cause).getWidget());
100        }
101        return new CmsWidgetException(container, cause);
102    }
103
104    /**
105     * Returns the widget that caused the error.<p>
106     *
107     * If the widget has not been set, this will return <code>null</code>.<p>
108     *
109     * @return the widget that caused the error
110     */
111    public Object getWidget() {
112
113        return m_widget;
114    }
115}