org.w3c.dom.DOMException 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;

/**
 * DOM operations only raise exceptions in "exceptional" circumstances, i.e.,
 * when an operation is impossible to perform (either for logical reasons,
 * because data is lost, or because the implementation has become unstable).
 * In general, DOM methods return specific error values in ordinary processing
 * situations, such as out-of-bound errors when using NodeList.
 * 
 * 
 * Implementations should raise other exceptions under other circumstances. For
 * example, implementations should raise an implementation-dependent exception
 * if a null argument is passed when null was not
 * expected.
 * 
 * 
 * 
 * Some languages and object systems do not support the concept of exceptions.
 * For such systems, error conditions may be indicated using native error
 * reporting mechanisms. For some bindings, for example, methods may return
 * error codes similar to those listed in the corresponding method
 * descriptions.
 * 
 * 
 * 
 * See also the Document
 * Object Model (DOM) Level 3 Core Specification .
 * 
 */
public class DOMException
    extends RuntimeException {
    // ExceptionCode

    static final long serialVersionUID = 6627732366795969916L;

	/** If index or size is negative, or greater than the allowed value. */
    public static final short INDEX_SIZE_ERR = 1;

    /**
     * If the specified range of text does not fit into a
     * DOMString.
     */
    public static final short DOMSTRING_SIZE_ERR = 2;

    /** If any Node is inserted somewhere it doesn't belong. */
    public static final short HIERARCHY_REQUEST_ERR = 3;

    /**
     * If a Node is used in a different document than the one that
     * created it (that doesn't support it).
     */
    public static final short WRONG_DOCUMENT_ERR = 4;

    /**
     * If an invalid or illegal character is specified, such as in an XML name.
     */
    public static final short INVALID_CHARACTER_ERR = 5;

    /**
     * If data is specified for a Node which does not support
     * data.
     */
    public static final short NO_DATA_ALLOWED_ERR = 6;

    /**
     * If an attempt is made to modify an object where modifications are not
     * allowed.
     */
    public static final short NO_MODIFICATION_ALLOWED_ERR = 7;

    /**
     * If an attempt is made to reference a Node in a context
     * where it does not exist.
     */
    public static final short NOT_FOUND_ERR = 8;

    /**
     * If the implementation does not support the requested type of object or
     * operation.
     */
    public static final short NOT_SUPPORTED_ERR = 9;

    /**
     * If an attempt is made to add an attribute that is already in use
     * elsewhere.
     */
    public static final short INUSE_ATTRIBUTE_ERR = 10;

    /**
     * If an attempt is made to use an object that is not, or is no longer,
     * usable.
     *
     * @since DOM Level 2
     */
    public static final short INVALID_STATE_ERR = 11;

    /**
     * If an invalid or illegal string is specified.
     *
     * @since DOM Level 2
     */
    public static final short SYNTAX_ERR = 12;

    /**
     * If an attempt is made to modify the type of the underlying object.
     *
     * @since DOM Level 2
     */
    public static final short INVALID_MODIFICATION_ERR = 13;

    /**
     * If an attempt is made to create or change an object in a way which is
     * incorrect with regard to namespaces.
     *
     * @since DOM Level 2
     */
    public static final short NAMESPACE_ERR = 14;

    /**
     * If a parameter or an operation is not supported by the underlying
     * object.
     *
     * @since DOM Level 2
     */
    public static final short INVALID_ACCESS_ERR = 15;

    /**
     * If a call to a method such as insertBefore or
     * removeChild would make the Node invalid with
     * respect to "partial validity", this exception would be raised and the
     * operation would not be done. This code is used in [ DOM
     * Level 3 Validation ] . Refer to this specification for further
     * information.
     *
     * @since DOM Level 3
     */
    public static final short VALIDATION_ERR = 16;

    /**
     * If the type of an object is incompatible with the expected type of the
     * parameter associated to the object.
     *
     * @since DOM Level 3
     */
    public static final short TYPE_MISMATCH_ERR = 17;

    /** DOCUMENT ME! */
    public short code;

    /**
     * Creates a new DOMException object.
     *
     * @param code DOCUMENT ME!
     * @param message DOCUMENT ME!
     */
    public DOMException(
        short code,
        String message
    ) {
        super(message);
        this.code = code;
    }
}