KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xni > parser > XMLErrorHandler


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.xni.parser;
59
60 import com.sun.org.apache.xerces.internal.xni.XNIException;
61
62 /**
63  * An interface for handling errors. If the application is interested
64  * in error notifications, then it can register an error handler object
65  * that implements this interface with the parser configuration.
66  *
67  * @see XMLParserConfiguration
68  *
69  * @author Andy Clark, IBM
70  *
71  * @version $Id: XMLErrorHandler.java,v 1.3 2002/01/29 01:15:19 lehors Exp $
72  */
73 public interface XMLErrorHandler {
74
75     //
76 // XMLErrorHandler methods
77 //
78
79     /**
80      * Reports a warning. Warnings are non-fatal and can be safely ignored
81      * by most applications.
82      *
83      * @param domain The domain of the warning. The domain can be any
84      * string but is suggested to be a valid URI. The
85      * domain can be used to conveniently specify a web
86      * site location of the relevent specification or
87      * document pertaining to this warning.
88      * @param key The warning key. This key can be any string and
89      * is implementation dependent.
90      * @param exception Exception.
91      *
92      * @throws XNIException Thrown to signal that the parser should stop
93      * parsing the document.
94      */
95     public void warning(String JavaDoc domain, String JavaDoc key,
96                         XMLParseException exception) throws XNIException;
97
98     /**
99      * Reports an error. Errors are non-fatal and usually signify that the
100      * document is invalid with respect to its grammar(s).
101      *
102      * @param domain The domain of the error. The domain can be any
103      * string but is suggested to be a valid URI. The
104      * domain can be used to conveniently specify a web
105      * site location of the relevent specification or
106      * document pertaining to this error.
107      * @param key The error key. This key can be any string and
108      * is implementation dependent.
109      * @param exception Exception.
110      *
111      * @throws XNIException Thrown to signal that the parser should stop
112      * parsing the document.
113      */
114     public void error(String JavaDoc domain, String JavaDoc key,
115                       XMLParseException exception) throws XNIException;
116
117     /**
118      * Report a fatal error. Fatal errors usually occur when the document
119      * is not well-formed and signifies that the parser cannot continue
120      * normal operation.
121      * <p>
122      * <strong>Note:</strong> The error handler should <em>always</em>
123      * throw an <code>XNIException</code> from this method. This exception
124      * can either be the same exception that is passed as a parameter to
125      * the method or a new XNI exception object. If the registered error
126      * handler fails to throw an exception, the continuing operation of
127      * the parser is undetermined.
128      *
129      * @param domain The domain of the fatal error. The domain can be
130      * any string but is suggested to be a valid URI. The
131      * domain can be used to conveniently specify a web
132      * site location of the relevent specification or
133      * document pertaining to this fatal error.
134      * @param key The fatal error key. This key can be any string
135      * and is implementation dependent.
136      * @param exception Exception.
137      *
138      * @throws XNIException Thrown to signal that the parser should stop
139      * parsing the document.
140      */
141     public void fatalError(String JavaDoc domain, String JavaDoc key,
142                            XMLParseException exception) throws XNIException;
143
144 } // interface XMLErrorHandler
145
Popular Tags