org.apache.jackrabbit.vault.util.xml.xerces.dom.DOMErrorImpl Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jackrabbit.vault.util.xml.xerces.dom;

import org.apache.jackrabbit.vault.util.xml.xerces.xni.parser.XMLParseException;
import org.w3c.dom.DOMError;
import org.w3c.dom.DOMLocator;


/**
 * {@code DOMErrorImpl} is an implementation that describes an error.
 * Note: The error object that describes the error
 * might be reused by Xerces implementation, across multiple calls to the
 * handleEvent method on DOMErrorHandler interface.
 * 
 * 

 * See also the Document Object Model (DOM) Level 3 Core Specification.
 *
 * @author Gopal Sharma, SUN Microsystems Inc.
 * @author Elena Litani, IBM
 * @version $Id$
 */

// REVISIT: the implementation of ErrorReporter. 
//          we probably should not pass XMLParseException
//

public class DOMErrorImpl implements DOMError {

    //
    // Data
    //

    public short fSeverity = DOMError.SEVERITY_WARNING;
    public String fMessage = null;
    public DOMLocatorImpl fLocator = new DOMLocatorImpl();
    public Exception fException = null;
    public String fType;
    public Object fRelatedData;


    //
    // Constructors
    //

    /**
     * Default constructor.
     */
    public DOMErrorImpl() {
    }

    /**
     * Exctracts information from XMLParserException)
     */
    public DOMErrorImpl(short severity, XMLParseException exception) {
        fSeverity = severity;
        fException = exception;
        fLocator = createDOMLocator(exception);
    }

    /**
     * The severity of the error, either {@code SEVERITY_WARNING},
     * {@code SEVERITY_ERROR}, or {@code SEVERITY_FATAL_ERROR}.
     */

    public short getSeverity() {
        return fSeverity;
    }

    /**
     * An implementation specific string describing the error that occured.
     */

    public String getMessage() {
        return fMessage;
    }

    /**
     * The location of the error.
     */

    public DOMLocator getLocation() {
        return fLocator;
    }

    // method to get the DOMLocator Object
    private DOMLocatorImpl createDOMLocator(XMLParseException exception) {
        // assuming DOMLocator wants the *expanded*, not the literal, URI of the doc... - neilg
        return new DOMLocatorImpl(exception.getLineNumber(),
                exception.getColumnNumber(),
                exception.getExpandedSystemId()
        );
    } // createDOMLocator()


    /**
     * The related platform dependent exception if any.exception is a reserved
     * word, we need to rename it.Change to "relatedException". (F2F 26 Sep
     * 2001)
     */
    public Object getRelatedException() {
        return fException;
    }

    public void reset() {
        fSeverity = DOMError.SEVERITY_WARNING;
        fException = null;
    }

    public String getType() {
        return fType;
    }

    public Object getRelatedData() {
        return fRelatedData;
    }


}// class DOMErrorImpl