/*
 * @(#)SQLRecoverableException.java	1.2 06/07/10
 *
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

package java.sql;

/**
 * The subclass of {@link SQLException} thrown in situations where a
 * previously failed operation might be able to succeed if the application performs
 *  some recovery steps and retries the entire transaction or in the case of a 
 * distributed transaction, the transaction branch.  At a minimum,
 * the recovery operation must include closing the current connection and getting 
 * a new connection.
 *<p>
 *
 * @since 1.6
 */
public class SQLRecoverableException extends java.sql.SQLException {

	/**
	 * Constructs a <code>SQLRecoverableException</code> object.
         * The <code>reason</code>, <code>SQLState</code> are initialized
         * to <code>null</code> and the vendor code is initialized to 0.
         *
         * The <code>cause</code> is not initialized, and may subsequently be
         * initialized by a call to the 
         * {@link Throwable#initCause(java.lang.Throwable)} method.
         * <p>
	 * @since 1.6
        */
	public SQLRecoverableException() {
		super();
	}
	
	/**
	 * Constructs a <code>SQLRecoverableException</code> object 
         *  with a given <code>reason</code>. The <code>SQLState</code> 
         * is initialized to <code>null</code> and the vender code is initialized 
         * to 0.
         *
         * The <code>cause</code> is not initialized, and may subsequently be
         * initialized by a call to the 
         * {@link Throwable#initCause(java.lang.Throwable)} method.
         * <p>
	 * @param reason a description of the exception
	 * @since 1.6
         */
	public SQLRecoverableException(String reason) {
		super(reason);
	}
	
	/**
	 * Constructs a <code>SQLRecoverableException</code> object 
         * with a given <code>reason</code> and <code>SQLState</code>.
         *
         * The <code>cause</code> is not initialized, and may subsequently be
         * initialized by a call to the 
         * {@link Throwable#initCause(java.lang.Throwable)} method. The vendor code
         * is initialized to 0.
         * <p>
	 * @param reason a description of the exception
	 * @param SQLState an XOPEN or SQL:2003 code identifying the exception
	 * @since 1.6
         */
	public SQLRecoverableException(String reason, String SQLState) {
		super(reason, SQLState);
	}	
	
	/**
	 * Constructs a <code>SQLRecoverableException</code> object
         *  with a given <code>reason</code>, <code>SQLState</code>  and 
         * <code>vendorCode</code>.
         *
         * The <code>cause</code> is not initialized, and may subsequently be
         * initialized by a call to the 
         * {@link Throwable#initCause(java.lang.Throwable)} method.
         * <p>
	 * @param reason a description of the exception
	 * @param SQLState an XOPEN or SQL:2003 code identifying the exception
	 * @param vendorCode a database vendor specific exception code
	 * @since 1.6
         */
	public SQLRecoverableException(String reason, String SQLState, int vendorCode) {
		super(reason, SQLState, vendorCode);
	}	
	
    /**
     * Constructs a <code>SQLRecoverableException</code> object 
     * with a given  <code>cause</code>.
     * The <code>SQLState</code> is initialized
     * to <code>null</code> and the vendor code is initialized to 0. 
     * The <code>reason</code>  is initialized to <code>null</code> if 
     * <code>cause==null</code> or to <code>cause.toString()</code> if 
     * <code>cause!=null</code>.
     * <p>
     * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating
     *     the cause is non-existent or unknown.
     * @since 1.6
     */
    public SQLRecoverableException(Throwable cause) {
    	super(cause);
    }

    /**
     * Constructs a <code>SQLRecoverableException</code> object 
     * with a given
     * <code>reason</code> and  <code>cause</code>.  
     * The <code>SQLState</code> is  initialized to <code>null</code>
     * and the vendor code is initialized to 0.
     * <p>
     * @param reason a description of the exception. 
     * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating
     *     the cause is non-existent or unknown.
     * @since 1.6
     */
    public SQLRecoverableException(String reason, Throwable cause) {
    	super(reason, cause);
    }
    
    /**
     * Constructs a <code>SQLRecoverableException</code> object 
     * with a given
     * <code>reason</code>, <code>SQLState</code> and  <code>cause</code>.  
     * The vendor code is initialized to 0.
     * <p>
     * @param reason a description of the exception. 
     * @param SQLState an XOPEN or SQL:2003 code identifying the exception 
     * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating
     *     the cause is non-existent or unknown.
     * @since 1.6
     */
    public SQLRecoverableException(String reason, String SQLState, Throwable cause) {
        super(reason, SQLState, cause);
    }
    
    /**
     *  Constructs a <code>SQLRecoverableException</code> object
     * with a given
     * <code>reason</code>, <code>SQLState</code>, <code>vendorCode</code>
     * and  <code>cause</code>.  
     * <p>
     * @param reason a description of the exception 
     * @param SQLState an XOPEN or SQL:2003 code identifying the exception
     * @param vendorCode a database vendor-specific exception code
     * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating
     *     the cause is non-existent or unknown.
     * @since 1.6
     */
    public SQLRecoverableException(String reason, String SQLState, int vendorCode, Throwable cause) {
    	super(reason, SQLState, vendorCode, cause);
    }
  
   private static final long serialVersionUID = -4144386502923131579L;
}