View Javadoc

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 an error occurs due to the way the calling application uses the plugins module. Because the pre-existing
24   * Digester API doesn't provide any option for throwing checked exceptions at some points where Plugins can potentially
25   * fail, this exception extends RuntimeException so that it can "tunnel" through these points.
26   * 
27   * @since 1.6
28   */
29  public class PluginConfigurationException
30      extends RuntimeException
31  {
32  
33      private static final long serialVersionUID = 1L;
34  
35      /**
36       * Constructs a new exception with the specified cause.
37       *
38       * @param cause underlying exception that caused this to be thrown
39       */
40      public PluginConfigurationException( Throwable cause )
41      {
42          super( cause );
43      }
44  
45      /**
46       * Constructs a new exception with the specified detail message.
47       *
48       * @param msg describes the reason this exception is being thrown.
49       */
50      public PluginConfigurationException( String msg )
51      {
52          super( msg );
53      }
54  
55      /**
56       * Constructs a new exception with the specified detail message and cause.
57       *
58       * @param msg describes the reason this exception is being thrown.
59       * @param cause underlying exception that caused this to be thrown
60       */
61      public PluginConfigurationException( String msg, Throwable cause )
62      {
63          super( msg, cause );
64      }
65  
66  }