/*

 * Copyright 2000-2005 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.xml.parsers;

/**

 * Thrown when a problem with configuration with the Parser Factories

 * exists. This error will typically be thrown when the class of a

 * parser factory specified in the system properties cannot be found

 * or instantiated.

 *

 * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a>

 */

public class FactoryConfigurationError extends Error {

    /**

     *<code>Exception</code> that represents the error.

     */

    private Exception exception;

    /**

     * Create a new <code>FactoryConfigurationError</code> with no

     * detail mesage.

     */

    public FactoryConfigurationError() {

        super();

        this.exception = null;

    }

    /**

     * Create a new <code>FactoryConfigurationError</code> with

     * the <code>String </code> specified as an error message.

     *

     * @param msg The error message for the exception.

     */

    public FactoryConfigurationError(String msg) {

        super(msg);

        this.exception = null;

    }

    /**

     * Create a new <code>FactoryConfigurationError</code> with a

     * given <code>Exception</code> base cause of the error.

     *

     * @param e The exception to be encapsulated in a

     * FactoryConfigurationError.

     */

    public FactoryConfigurationError(Exception e) {

        super(e.toString());

        this.exception = e;

    }

    /**

     * Create a new <code>FactoryConfigurationError</code> with the

     * given <code>Exception</code> base cause and detail message.

     *

     * @param e The exception to be encapsulated in a

     * FactoryConfigurationError

     * @param msg The detail message.

     */

    public FactoryConfigurationError(Exception e, String msg) {

        super(msg);

        this.exception = e;

    }

    /**

     * Return the message (if any) for this error . If there is no

     * message for the exception and there is an encapsulated

     * exception then the message of that exception, if it exists will be

     * returned. Else the name of the encapsulated exception will be

     * returned.

     *

     * @return The error message.

     */

    public String getMessage () {

        String message = super.getMessage ();

        if (message == null && exception != null) {

            return exception.getMessage();

        }

        return message;

    }

    /**

     * Return the actual exception (if any) that caused this exception to

     * be raised.

     *

     * @return The encapsulated exception, or null if there is none.

     */

    public Exception getException () {

        return exception;

    }

}