001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999,2000 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 org.apache.xerces.framework;
059:
060: import org.xml.sax.Locator;
061:
062: /**
063: * Error handling
064: *
065: * @version $Id: XMLErrorReporter.java,v 1.2 2000/04/04 21:14:21 andyc Exp $
066: */
067: public interface XMLErrorReporter {
068: //
069: // Constants
070: //
071:
072: /** Warning type. */
073: public static final int ERRORTYPE_WARNING = 0;
074:
075: /** Error type. */
076: public static final int ERRORTYPE_RECOVERABLE_ERROR = 1;
077:
078: /** Fatal error type. */
079: public static final int ERRORTYPE_FATAL_ERROR = 2;
080:
081: /**
082: * Get the default locator to use when reporting errors.
083: */
084: public Locator getLocator();
085:
086: /**
087: * Report an error detected by a component of the XML parser.
088: * In a typical implementation of this interface, this method
089: * would call the error handler registered by the user with
090: * the appropriate error information.
091: *
092: * @param locator Used to determine the location of the error.
093: * @param errorDomain The error domain of the error.
094: * @param majorCode The major key for the message text.
095: * @param minorCode The minor key for the message text.
096: * @param args The arguments to be used as replacement text
097: * in the message created.
098: * @param errorType The type of error (ERRORTYPE_WARNING, ERRORTYPE_RECOVERABLE_ERROR, ERRORTYPE_FATAL_ERROR).
099: *
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 locator, String errorDomain,
108: int majorCode, int minorCode, Object args[], int errorType)
109: throws Exception;
110: }
|