org.w3c.dom.DOMErrorHandler Maven / Gradle / Ivy

/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom;

/**
 *  DOMErrorHandler is a callback interface that the DOM
 * implementation can call when reporting errors that happens while
 * processing XML data, or when doing some other processing (e.g. validating
 * a document). A DOMErrorHandler object can be attached to a
 * Document using the "error-handler" on the
 * DOMConfiguration interface. If more than one error needs to
 * be reported during an operation, the sequence and numbers of the errors
 * passed to the error handler are implementation dependent.
 *  The application that is using the DOM implementation is expected to
 * implement this interface.
 * See also the Document Object Model (DOM) Level 3 Core Specification.
 * @since DOM Level 3
 */
public interface DOMErrorHandler {
    /**
     * This method is called on the error handler when an error occurs.
     * 
 If an exception is thrown from this method, it is considered to be
     * equivalent of returning true.
     * @param error  The error object that describes the error. This object
     *   may be reused by the DOM implementation across multiple calls to
     *   the handleError method.
     * @return  If the handleError method returns
     *   false, the DOM implementation should stop the current
     *   processing when possible. If the method returns true,
     *   the processing may continue depending on
     *   DOMError.severity.
     */
    public boolean handleError(DOMError error);

}