001/* $Id: PluginException.java 992060 2010-09-02 19:09:47Z simonetripodi $
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 some plugin-related error has occurred, and none of the
023 * other exception types are appropriate.
024 *
025 * @since 1.6
026 */
027
028public class PluginException extends Exception {
029
030    private static final long serialVersionUID = 1L;
031    private Throwable cause = null;
032
033    /**
034     * @param cause underlying exception that caused this to be thrown
035     */
036    public PluginException(Throwable cause) {
037        this(cause.getMessage());
038        this.cause = cause;
039    }
040
041    /**
042     * @param msg describes the reason this exception is being thrown.
043     */
044    public PluginException(String msg) {
045        super(msg);
046    }
047
048    /**
049     * @param msg describes the reason this exception is being thrown.
050     * @param cause underlying exception that caused this to be thrown
051     */
052    public PluginException(String msg, Throwable cause) {
053        this(msg);
054        this.cause = cause;
055    }
056    
057    /**
058     * @return the underlying exception that caused this to be thrown
059     */
060    @Override
061    public Throwable getCause() {
062        return cause;
063    }
064}