/* BatchUpdateException.java -- Exception for batch oriented SQL errors
   Copyright (C) 1999, 2000 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */


package java.sql;

/**
  * This class extends <code>SQLException</code> to count the successful
  * updates in each statement in a batch that was successfully updated prior 
  * to the error.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class BatchUpdateException extends SQLException 
{

/*************************************************************************/

/*
 * Instance Variables
 */

/**
  * This is the array of update counts for the commands which completed
  * successfully prior to the error.
  * @serialized
  */
private int[] updateCounts;

/*************************************************************************/

/*
 * Constructors
 */

/**
  * This method initializes a new instance of <code>BatchUpdateException</code>
  * with no descriptive error message.  The SQL state and update count will
  * be initialized to <code>null</code> and the vendor specific error code will 
  * initialized to 0.
  */
public
BatchUpdateException()
{
  super();
} 

/*************************************************************************/

/**
  * This method initializes a new instance of <code>BatchUpdateException</code>
  * with the specified update count information and no descriptive error
  * message.  This SQL state will be initialized to <code>null</code> and
  * the vendor specific error code will be initialized to 0.
  *
  * @param updateCounts The update count array.
  */
public
BatchUpdateException(int[] updateCounts)
{
  super();
  
  this.updateCounts = updateCounts;
}

/*************************************************************************/

/**
  * This method initializes a new instance of <code>BatchUpdateException</code>
  * with the specified descriptive error message and update count information.
  * The SQL state will be initialized to <code>null</code> and the vendor
  * specific error code will be initialized to 0.
  *
  * @param message The descriptive error message.
  * @param updateCounts The update count information for this error.
  */
public
BatchUpdateException(String message, int[] updateCounts)
{
  super(message);

  this.updateCounts = updateCounts;
}

/*************************************************************************/

/**
  * This method initializes a new instance of <code>BatchUpdateException</code>
  * with the specified descriptive error message, SQL state, and update count
  * information.  The vendor specific error code will be initialized to 0.
  *
  * @param message The descriptive error message.
  * @param SQLState The SQL state information for this error.
  * @param updateCounts The update count information for this error.
  */
public
BatchUpdateException(String message, String SQLState, int[] updateCounts)
{
  super(message, SQLState);

  this.updateCounts = updateCounts;
}

/*************************************************************************/

/**
  * This method initializes a new instance of <code>BatchUpdateException</code>
  * with the specified descriptive error message, SQL state, vendor
  * specific error code and update count information.
  *
  * @param message The descriptive error message.
  * @param SQLState The SQL state information for this error.
  * @param vendorCode The vendor specific error code for this error.
  * @param updateCounts The update count information for this error.
  */
public
BatchUpdateException(String message, String SQLState, int vendorCode,
                     int[] updateCounts)
{
  super(message, SQLState, vendorCode);

  this.updateCounts = updateCounts;
}

/*************************************************************************/

/*
 * Instance Methods
 */

/**
  * This method returns the update count information for this error.  If
  * not <code>null</code> this is an array of <code>int</code>'s that are
  * the update accounts for each command that was successfully executed.
  * The array elements are in the order that the commands were executed.
  *
  * @return The update count information, which may be <code>null</code>.
  */
public int[]
getUpdateCounts()
{
  return(updateCounts);
}

} // class BatchUpdateException