/*
 * Copyright (c) 2007 BUSINESS OBJECTS SOFTWARE LIMITED
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *  
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *  
 *     * Neither the name of Business Objects nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *  
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/*
 * BadXMLDocumentException.java
 * Creation date: (Jun 11, 2002 4:23:29 PM)
 * By: Edward Lam
 */
 package org.openquark.util.xml;

import org.openquark.util.BusinessObjectsException;
import org.w3c.dom.Node;


/**
 * A BadXMLDocumentException is thrown when an error is encountered while attempting to interpret a DOM Document.
 * Creation date: (Jun 11, 2002 4:23:29 PM)
 * @author Edward Lam
 */
public class BadXMLDocumentException extends BusinessObjectsException {

    private static final long serialVersionUID = -3261810682341915609L;
    
    /** The node related to the exception in question. */
    private final Node errorNode;
    
    /**
     * Constructor for a BadXMLDocumentException.
     * Creation date: (Jun 11, 2002 4:25:07 PM)
     */
    public BadXMLDocumentException(Node errorNode, String errorText) {
        super(errorText);
        this.errorNode = errorNode;
    }
    
    /**
     * Get the node associated with this exception.
     * Creation date: (Jun 11, 2002 4:28:23 PM)
     * @return Node the node associated with the exception.
     */
    public Node getErrorNode() {
        return errorNode;
    }
}