001package org.apache.commons.digester3.plugins;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Thrown when some plugin-related error has occurred, and none of the other exception types are appropriate.
024 * 
025 * @since 1.6
026 */
027public class PluginException
028    extends Exception
029{
030
031    private static final long serialVersionUID = 1L;
032
033    private Throwable cause = null;
034
035    /**
036     * @param cause underlying exception that caused this to be thrown
037     */
038    public PluginException( Throwable cause )
039    {
040        this( cause.getMessage() );
041        this.cause = cause;
042    }
043
044    /**
045     * @param msg describes the reason this exception is being thrown.
046     */
047    public PluginException( String msg )
048    {
049        super( msg );
050    }
051
052    /**
053     * @param msg describes the reason this exception is being thrown.
054     * @param cause underlying exception that caused this to be thrown
055     */
056    public PluginException( String msg, Throwable cause )
057    {
058        this( msg );
059        this.cause = cause;
060    }
061
062    /**
063     * @return the underlying exception that caused this to be thrown
064     */
065    @Override
066    public Throwable getCause()
067    {
068        return cause;
069    }
070
071}