001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2001, 2002 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package com.sun.xml.stream.xerces.xni.parser;
059:
060: import com.sun.xml.stream.xerces.xni.XNIException;
061:
062: /**
063: * An interface for handling errors. If the application is interested
064: * in error notifications, then it can register an error handler object
065: * that implements this interface with the parser configuration.
066: *
067: * @see XMLParserConfiguration
068: *
069: * @author Andy Clark, IBM
070: *
071: * @version $Id: XMLErrorHandler.java,v 1.2 2006/04/01 06:01:43 jeffsuttor Exp $
072: */
073: public interface XMLErrorHandler {
074:
075: //
076: // XMLErrorHandler methods
077: //
078:
079: /**
080: * Reports a warning. Warnings are non-fatal and can be safely ignored
081: * by most applications.
082: *
083: * @param domain The domain of the warning. The domain can be any
084: * string but is suggested to be a valid URI. The
085: * domain can be used to conveniently specify a web
086: * site location of the relevent specification or
087: * document pertaining to this warning.
088: * @param key The warning key. This key can be any string and
089: * is implementation dependent.
090: * @param exception Exception.
091: *
092: * @throws XNIException Thrown to signal that the parser should stop
093: * parsing the document.
094: */
095: public void warning(String domain, String key,
096: XMLParseException exception) throws XNIException;
097:
098: /**
099: * 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 domain, String 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 domain, String key,
142: XMLParseException exception) throws XNIException;
143:
144: } // interface XMLErrorHandler
|