rdonkin 2003/11/02 15:26:42
Added: digester/src/java/org/apache/commons/digester/plugins
PluginAssertionFailure.java
Log:
Replaced Error subclass with RuntimeException. Patch sbumitted by Simon Kitching.
Revision Changes Path
1.1
jakarta-commons/digester/src/java/org/apache/commons/digester/plugins/PluginAssertionFailure.java
Index: PluginAssertionFailure.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-commons/digester/src/java/org/apache/commons/digester/plugins/PluginAssertionFailure.java,v
1.1 2003/11/02 23:26:42 rdonkin Exp $
* $Revision: 1.1 $
* $Date: 2003/11/02 23:26:42 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. The names "Apache", "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache" nor may "Apache" appear in their names without prior
* written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.digester.plugins;
/**
* Thrown when a bug is detected in the plugins code.
* <p>
* This class is intended to be used in assertion statements, similar to
* the way that java 1.4's native assertion mechanism is used. However there
* is a difference: when a java 1.4 assertion fails, an AssertionError
* is thrown, which is a subclass of Error; here, the PluginAssertionFailure
* class extends RuntimeException rather than Error.
* <p>
* This difference in design is because throwing Error objects is not
* good in a container-based architecture.
* <p>
* Example:
* <pre>
* if (impossibleCondition) {
* throw new PluginAssertionFailure(
* "internal error: impossible condition is true");
* }
* </pre>
* <p>
* Note that PluginAssertionFailure should <i>not</i> be thrown when user
* input is bad, or when code external to the Digester module passes invalid
* parameters to a plugins method. It should be used only in checks for
* problems which indicate internal bugs within the plugins module.
*
* @author Simon Kitching
*/
public class PluginAssertionFailure extends RuntimeException {
private Throwable cause = null;
/**
* @param cause underlying exception that caused this to be thrown
*/
public PluginAssertionFailure(Throwable cause) {
this(cause.getMessage());
this.cause = cause;
}
/**
* @param msg describes the reason this exception is being thrown.
*/
public PluginAssertionFailure(String msg) {
super(msg);
}
/**
* @param msg describes the reason this exception is being thrown.
* @param cause underlying exception that caused this to be thrown
*/
public PluginAssertionFailure(String msg, Throwable cause) {
this(msg);
this.cause = cause;
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]