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

/*
 * Copyright (C) 2005 by Quentin Anciaux
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed 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. See the GNU Library General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *	@author Quentin Anciaux
 */

package org.w3c.dom;

/**
 * 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. The return value of
     * DOMErrorHandler.handleError() is ignored unless the
     * implementation chooses to continue, in which case the behavior becomes
     * undefined.
     */
    public static final short SEVERITY_FATAL_ERROR = 3;

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

    /**
     * An implementation specific string describing the error that occurred.
     *
     * @return DOCUMENT ME!
     */
    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-sections-splitted" and the first
     * CDATASection node in document order resulting from the
     * split is returned by the relatedData attribute.
     *
     * @return DOCUMENT ME!
     */
    public String getType();

    /**
     * The related platform dependent exception if any.
     *
     * @return DOCUMENT ME!
     */
    public Object getRelatedException();

    /**
     * The related DOMError.type dependent data if any.
     *
     * @return DOCUMENT ME!
     */
    public Object getRelatedData();

    /**
     * The location of the error.
     *
     * @return DOCUMENT ME!
     */
    public DOMLocator getLocation();
}