001/* $Id: PluginConfigurationException.java 476205 2006-11-17 16:43:10Z dennisl $
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one or more
004 * contributor license agreements.  See the NOTICE file distributed with
005 * this work for additional information regarding copyright ownership.
006 * The ASF licenses this file to You under the Apache License, Version 2.0
007 * (the "License"); you may not use this file except in compliance with
008 * the License.  You may obtain a copy of the License at
009 * 
010 *      http://www.apache.org/licenses/LICENSE-2.0
011 * 
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */ 
018
019package org.apache.commons.digester.plugins;
020
021/**
022 * Thrown when an error occurs due to the way the calling application uses
023 * the plugins module. Because the pre-existing Digester API doesn't provide
024 * any option for throwing checked exceptions at some points where Plugins
025 * can potentially fail, this exception extends RuntimeException so that it
026 * can "tunnel" through these points.
027 *
028 * @since 1.6
029 */
030
031public class PluginConfigurationException extends RuntimeException {
032    private Throwable cause = null;
033
034    /**
035     * @param cause underlying exception that caused this to be thrown
036     */
037    public PluginConfigurationException(Throwable cause) {
038        this(cause.getMessage());
039        this.cause = cause;
040    }
041
042    /**
043     * @param msg describes the reason this exception is being thrown.
044     */
045    public PluginConfigurationException(String msg) {
046        super(msg);
047    }
048
049    /**
050     * @param msg describes the reason this exception is being thrown.
051     * @param cause underlying exception that caused this to be thrown
052     */
053    public PluginConfigurationException(String msg, Throwable cause) {
054        this(msg);
055        this.cause = cause;
056    }
057
058    /**
059     * Return the cause of this exception (if any) as specified in the
060     * exception constructor.
061     * 
062     * @since 1.8
063     */
064    public Throwable getCause() {
065        return cause;
066    }
067}