001 /* $Id: PluginConfigurationException.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
019 package 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
031 public class PluginConfigurationException extends RuntimeException {
032
033 private static final long serialVersionUID = 1L;
034 private Throwable cause = null;
035
036 /**
037 * @param cause underlying exception that caused this to be thrown
038 */
039 public PluginConfigurationException(Throwable cause) {
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 PluginConfigurationException(String msg) {
048 super(msg);
049 }
050
051 /**
052 * @param msg describes the reason this exception is being thrown.
053 * @param cause underlying exception that caused this to be thrown
054 */
055 public PluginConfigurationException(String msg, Throwable cause) {
056 this(msg);
057 this.cause = cause;
058 }
059
060 /**
061 * Return the cause of this exception (if any) as specified in the
062 * exception constructor.
063 *
064 * @since 1.8
065 */
066 @Override
067 public Throwable getCause() {
068 return cause;
069 }
070 }