KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > framework > XMLErrorReporter


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999,2000 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 org.enhydra.apache.xerces.framework;
59
60 import org.xml.sax.Locator JavaDoc;
61
62 /**
63  * Error handling
64  *
65  * @version $Id: XMLErrorReporter.java,v 1.1.1.1 2003/03/10 16:34:34 taweili Exp $
66  */

67 public interface XMLErrorReporter {
68     //
69
// Constants
70
//
71

72     /** Warning type. */
73     public static final int ERRORTYPE_WARNING = 0;
74
75     /** Error type. */
76     public static final int ERRORTYPE_RECOVERABLE_ERROR = 1;
77
78     /** Fatal error type. */
79     public static final int ERRORTYPE_FATAL_ERROR = 2;
80
81     /**
82      * Get the default locator to use when reporting errors.
83      */

84     public Locator JavaDoc getLocator();
85
86     /**
87      * Report an error detected by a component of the XML parser.
88      * In a typical implementation of this interface, this method
89      * would call the error handler registered by the user with
90      * the appropriate error information.
91      *
92      * @param locator Used to determine the location of the error.
93      * @param errorDomain The error domain of the error.
94      * @param majorCode The major key for the message text.
95      * @param minorCode The minor key for the message text.
96      * @param args The arguments to be used as replacement text
97      * in the message created.
98      * @param errorType The type of error (ERRORTYPE_WARNING, ERRORTYPE_RECOVERABLE_ERROR, ERRORTYPE_FATAL_ERROR).
99      *
100      * @see #ERRORTYPE_WARNING
101      * @see #ERRORTYPE_RECOVERABLE_ERROR
102      * @see #ERRORTYPE_FATAL_ERROR
103      *
104      * @exception Exception Thrown if the parser should not continue
105      * to the error being handled.
106      */

107     public void reportError(Locator JavaDoc locator,
108                             String JavaDoc errorDomain,
109                             int majorCode,
110                             int minorCode,
111                             Object JavaDoc args[],
112                             int errorType) throws Exception JavaDoc;
113 }
114
Popular Tags