org.apache.xerces.dom3.DOMError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl

Xerces2 provides high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces continues to build upon the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 provides fully conforming XML Schema 1.0 and 1.1 processors. An experimental implementation of the "XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010)" is also provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

There is a newer version: 2.12.2

Show newest version

/*
 * Copyright (c) 2003 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.apache.xerces.dom3;

/**
 * DOMError is an interface that describes an error.
 * See also the Document Object Model (DOM) Level 3 Core Specification.
 * @since DOM Level 3
 */
public interface DOMError {
    // ErrorSeverity
    /**
     * The severity of the error described by the DOMError is 
     * warning. A SEVERITY_WARNING will not cause the 
     * processing to stop, unless DOMErrorHandler.handleError() 
     * returns false.
     */
    public static final short SEVERITY_WARNING          = 1;
    /**
     * The severity of the error described by the DOMError is 
     * error. A SEVERITY_ERROR may not cause the processing to 
     * stop if the error can be recovered, unless 
     * DOMErrorHandler.handleError() returns false.
     */
    public static final short SEVERITY_ERROR            = 2;
    /**
     * The severity of the error described by the DOMError is 
     * fatal error. A SEVERITY_FATAL_ERROR will cause the 
     * normal processing to stop and the return value of 
     * DOMErrorHandler.handleError() is ignored. If the 
     * implementation chooses to continue, the behavior is undefined.
     */
    public static final short SEVERITY_FATAL_ERROR      = 3;

    /**
     * The severity of the error, either SEVERITY_WARNING, 
     * SEVERITY_ERROR, or SEVERITY_FATAL_ERROR.
     */
    public short getSeverity();

    /**
     * An implementation specific string describing the error that occurred.
     */
    public String getMessage();

    /**
     *  A DOMString indicating which related data is expected in 
     * relatedData. Users should refer to the specification of 
     * the error in order to find its DOMString type and 
     * relatedData definitions if any. 
     * Note:  As an example, 
     * Document.normalizeDocument() does generate warnings when 
     * the "split-cdata-sections" parameter is in use. Therefore, the method 
     * generates a SEVERITY_WARNING with type 
     * "cdata-section-splitted" and the first 
     * CDATASection node in document order resulting from the 
     * split is returned by the relatedData attribute. 
     */
    public String getType();

    /**
     * The related platform dependent exception if any.
     */
    public Object getRelatedException();

    /**
     *  The related DOMError.type dependent data if any. 
     */
    public Object getRelatedData();

    /**
     * The location of the error.
     */
    public DOMLocator getLocation();

}