1 package org.apache.commons.digester3.plugins;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * Thrown when some plugin-related error has occurred, and none of the other exception types are appropriate.
24 *
25 * @since 1.6
26 */
27 public class PluginException
28 extends Exception
29 {
30
31 private static final long serialVersionUID = 1L;
32
33 private Throwable cause = null;
34
35 /**
36 * @param cause underlying exception that caused this to be thrown
37 */
38 public PluginException( Throwable cause )
39 {
40 this( cause.getMessage() );
41 this.cause = cause;
42 }
43
44 /**
45 * @param msg describes the reason this exception is being thrown.
46 */
47 public PluginException( String msg )
48 {
49 super( msg );
50 }
51
52 /**
53 * @param msg describes the reason this exception is being thrown.
54 * @param cause underlying exception that caused this to be thrown
55 */
56 public PluginException( String msg, Throwable cause )
57 {
58 this( msg );
59 this.cause = cause;
60 }
61
62 /**
63 * @return the underlying exception that caused this to be thrown
64 */
65 @Override
66 public Throwable getCause()
67 {
68 return cause;
69 }
70
71 }