KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > xml > xdbc > XMLErrorHandler


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.xml.xdbc;
24
25 /**
26  * Interface for XMLDBC storage error handlers.
27  *
28  * <p>If an XMLDBC application needs to implement customized error
29  * handling, it must implement this interface and then register an
30  * instance with the XMLDocumentFiler using the
31  * {@link org.xquark.xml.xdbc.XMLDocumentFiler#setErrorHandler setErrorHandler}
32  * method. The document filer will then report all errors and warnings
33  * through this interface.</p>
34  *
35  * <p>Fatal errors, i.e., errors making storage impossible are not reported
36  * through this interface but carry out exceptions.</p>
37  *
38  * @see org.xquark.xml.xdbc.XMLDocumentFiler#setErrorHandler
39  * @see org.xquark.xml.xdbc.XMLDBCException
40  */
41 public interface XMLErrorHandler
42 {
43  
44
45     /**
46      * Receive notification of a warning. For instance the risk of data loss
47      *
48      * @param exception The warning information encapsulated in an XMLDBC exception.
49      * @exception XMLDBCException Any XMLDBC exception, possibly
50      * wrapping another exception.
51      * @see org.xquark.xml.xdbc.XMLDBCException
52      */
53     public void warning (XMLDBCException exception)
54     throws XMLDBCException;
55     
56     
57     /**
58      * Receive notification of an error that did not prevent the document storage.
59      *
60      * @param exception The error information encapsulated in an XMLDBC exception.
61      * @exception XMLDBCException Any XMLDBC exception, possibly
62      * wrapping another exception.
63      * @see org.xquark.xml.xdbc.XMLDBCException
64      */
65     public void error (XMLDBCException exception)
66     throws XMLDBCException;
67 }
68
Popular Tags