KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > main > CmsInitException


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/main/CmsInitException.java,v $
3  * Date : $Date: 2005/07/03 09:41:52 $
4  * Version: $Revision: 1.16 $
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.main;
33
34 import org.opencms.i18n.CmsMessageContainer;
35
36 /**
37  * Describes errors that occur in the context of OpenCms the initialization, this is fatal
38  * and prevents OpenCms from starting.<p>
39  *
40  * If an Exception of this class is thrown, OpenCms is set to an error state and
41  * the system won't try to start up again.<p>
42  *
43  * @author Alexander Kandzior
44  *
45  * @version $Revision: 1.16 $
46  *
47  * @since 6.0.0
48  */
49 public class CmsInitException extends CmsRuntimeException {
50
51     /** Serial version UID required for safe serialization. */
52     private static final long serialVersionUID = 7705928617426913316L;
53
54     /** Indicates that this exception describes a new error. */
55     private boolean m_newError;
56
57     /**
58      * Creates a new localized Exception.<p>
59      *
60      * @param container the localized message container to use
61      */
62     public CmsInitException(CmsMessageContainer container) {
63
64         this(container, true);
65     }
66
67     /**
68      * Creates a new localized Exception.<p>
69      *
70      * @param container the localized message container to use
71      * @param newError indicates that the error is new, and OpenCms should be stopped
72      */
73     public CmsInitException(CmsMessageContainer container, boolean newError) {
74
75         super(container);
76         m_newError = newError;
77         if (m_newError) {
78             setErrorCondition();
79         }
80     }
81
82     /**
83      * Creates a new localized Exception that also containes a root cause.<p>
84      *
85      * @param container the localized message container to use
86      * @param cause the Exception root cause
87      */
88     public CmsInitException(CmsMessageContainer container, Throwable JavaDoc cause) {
89
90         super(container, cause);
91         m_newError = true;
92         setErrorCondition();
93     }
94
95     /**
96      * @see org.opencms.main.CmsRuntimeException#createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)
97      */
98     public CmsRuntimeException createException(CmsMessageContainer container, Throwable JavaDoc cause) {
99
100         return new CmsInitException(container, cause);
101     }
102
103     /**
104      * Indicates that this exception describes a new error that was not already logged.<p>
105      *
106      * @return <code>true</code> if this exception describes a new error that was not already logged
107      */
108     public boolean isNewError() {
109
110         return m_newError;
111     }
112
113     /**
114      * Prints an error message to the System.err stream, indicating that OpenCms
115      * is unable to start up.<p>
116      */
117     private void setErrorCondition() {
118
119         CmsMessageContainer errorCondition = getMessageContainer();
120         OpenCmsCore.setErrorCondition(errorCondition);
121     }
122 }
123
Popular Tags