KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > widgets > CmsWidgetException


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/widgets/CmsWidgetException.java,v $
3  * Date : $Date: 2005/07/03 09:41:53 $
4  * Version: $Revision: 1.6 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.widgets;
33
34 import org.opencms.i18n.CmsMessageContainer;
35 import org.opencms.main.CmsException;
36 import org.opencms.workplace.CmsWidgetDialogParameter;
37
38 /**
39  * Describes errors that occur in the context of the OpenCms widgets.<p>
40  *
41  * @author Alexander Kandzior
42  *
43  * @version $Revision: 1.6 $
44  *
45  * @since 6.0.0
46  */
47 public class CmsWidgetException extends CmsException {
48
49     /** Serial version UID required for safe serialization. */
50     private static final long serialVersionUID = -7003923645953106868L;
51
52     /** The widget that caused the error. */
53     CmsWidgetDialogParameter m_widget;
54
55     /**
56      * Creates a new localized Exception.<p>
57      *
58      * @param container the localized message container to use
59      */
60     public CmsWidgetException(CmsMessageContainer container) {
61
62         this(container, (CmsWidgetDialogParameter)null);
63     }
64
65     /**
66      * Creates a new localized Exception.<p>
67      *
68      * @param container the localized message container to use
69      * @param widget the widget that caused the error
70      */
71     public CmsWidgetException(CmsMessageContainer container, CmsWidgetDialogParameter widget) {
72
73         super(container);
74         m_widget = widget;
75     }
76
77     /**
78      * Creates a new localized Exception that also containes a root cause.<p>
79      *
80      * @param container the localized message container to use
81      * @param cause the Exception root cause
82      */
83     public CmsWidgetException(CmsMessageContainer container, Throwable JavaDoc cause) {
84
85         this(container, cause, null);
86     }
87
88     /**
89      * Creates a new localized Exception that also containes a root cause.<p>
90      *
91      * @param container the localized message container to use
92      * @param cause the Exception root cause
93      * @param widget the widget that caused the error
94      */
95     public CmsWidgetException(CmsMessageContainer container, Throwable JavaDoc cause, CmsWidgetDialogParameter widget) {
96
97         super(container, cause);
98         m_widget = widget;
99     }
100
101     /**
102      * @see org.opencms.main.CmsException#createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)
103      */
104     public CmsException createException(CmsMessageContainer container, Throwable JavaDoc cause) {
105
106         if (cause instanceof CmsWidgetException) {
107             return new CmsWidgetException(container, cause, ((CmsWidgetException)cause).getWidget());
108         }
109         return new CmsWidgetException(container, cause);
110     }
111
112     /**
113      * Returns the widget that caused the error.<p>
114      *
115      * If the widget has not been set, this will return <code>null</code>.<p>
116      *
117      * @return the widget that caused the error
118      */
119     public CmsWidgetDialogParameter getWidget() {
120
121         return m_widget;
122     }
123 }
124
Popular Tags