Commons DBCP example source code file (DbcpException.java)

This example Commons DBCP source code file (DbcpException.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Commons DBCP tags/keywords

dbcpexception, dbcpexception, runtimeexception, runtimeexception, string, string, throwable, throwable

The Commons DBCP DbcpException.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.dbcp;


/**
 * <p>Subclass of RuntimeException that can be used to wrap
 * a <code>SQLException using the "root cause" pattern of JDK 1.4
 * exceptions, but without requiring a 1.4 runtime environment.</p>
 *
 * @author Jonathan Fuerth
 * @author Dan Fraser
 * @version $Revision: 883425 $ $Date: 2009-11-23 12:19:43 -0500 (Mon, 23 Nov 2009) $
 * 
 * @deprecated This will be removed in a future version of DBCP.
 **/
public class DbcpException extends RuntimeException {

    private static final long serialVersionUID = 2477800549022838103L;

    // ----------------------------------------------------------- Constructors


    /**
     * Construct a new runtime exception with <code>null as its
     * detail message.
     */
    public DbcpException() {

        super();

    }


    /**
     * Construct a new runtime exception with the specified detail message.
     *
     * @param message The detail message for this exception
     */
    public DbcpException(String message) {

        this(message, null);

    }


    /**
     * Construct a new runtime exception with the specified detail message
     * and cause.
     *
     * @param message The detail message for this exception
     * @param cause The root cause for this exception
     */
    public DbcpException(String message, Throwable cause) {

        super(message);
        this.cause = cause;

    }


    /**
     * Construct a new runtime exception with the specified cause and a
     * detail message of <code>(cause == null ? null : cause.toString()).
     *
     * @param cause The root cause for this exception
     */
    public DbcpException(Throwable cause) {

        super((cause == null) ? (String) null : cause.toString());
        this.cause = cause;

    }


    // ----------------------------------------------------- Instance Variables


    /**
     * The root cause of this exception (typically an
     * <code>SQLException but this is not required).
     */
    protected Throwable cause = null;


    // --------------------------------------------------------- Public Methods


    /**
     * Return the root cause of this exception (if any).
     */
    public Throwable getCause() {

        return (this.cause);

    }


}