java.sql
Class BatchUpdateException

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable 
      extended by java.lang.Exception sample code for java.lang.Exception definition code for java.lang.Exception 
          extended by java.sql.SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
              extended by java.sql.BatchUpdateException
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class BatchUpdateException
extends SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException

An exception thrown when an error occurs during a batch update operation. In addition to the information provided by SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException , a BatchUpdateException provides the update counts for all commands that were executed successfully during the batch update, that is, all commands that were executed before the error occurred. The order of elements in an array of update counts corresponds to the order in which commands were added to the batch.

After a command in a batch update fails to execute properly and a BatchUpdateException is thrown, the driver may or may not continue to process the remaining commands in the batch. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts will have an element for every command in the batch rather than only elements for the commands that executed successfully before the error. In the case where the driver continues processing commands, the array element for any command that failed is Statement.EXECUTE_FAILED.

Since:
1.2
See Also:
Serialized Form

Constructor Summary
BatchUpdateException sample code for java.sql.BatchUpdateException.BatchUpdateException() definition code for java.sql.BatchUpdateException.BatchUpdateException() ()
          Constructs a BatchUpdateException object with the reason, SQLState, and update count initialized to null and the vendor code initialized to 0.
BatchUpdateException sample code for java.sql.BatchUpdateException.BatchUpdateException(int[]) definition code for java.sql.BatchUpdateException.BatchUpdateException(int[]) (int[] updateCounts)
          Constructs a BatchUpdateException initialized to null for the reason and SQLState and 0 for the vendor code.
BatchUpdateException sample code for java.sql.BatchUpdateException.BatchUpdateException(java.lang.String, int[]) definition code for java.sql.BatchUpdateException.BatchUpdateException(java.lang.String, int[]) (String sample code for java.lang.String definition code for java.lang.String  reason, int[] updateCounts)
          Constructs a BatchUpdateException initialized with reason, updateCounts and null for the SQLState and 0 for the vendorCode.
BatchUpdateException sample code for java.sql.BatchUpdateException.BatchUpdateException(java.lang.String, java.lang.String, int[]) definition code for java.sql.BatchUpdateException.BatchUpdateException(java.lang.String, java.lang.String, int[]) (String sample code for java.lang.String definition code for java.lang.String  reason, String sample code for java.lang.String definition code for java.lang.String  SQLState, int[] updateCounts)
          Constructs a BatchUpdateException initialized with the given arguments (reason, SQLState, and updateCounts) and 0 for the vendor code.
BatchUpdateException sample code for java.sql.BatchUpdateException.BatchUpdateException(java.lang.String, java.lang.String, int, int[]) definition code for java.sql.BatchUpdateException.BatchUpdateException(java.lang.String, java.lang.String, int, int[]) (String sample code for java.lang.String definition code for java.lang.String  reason, String sample code for java.lang.String definition code for java.lang.String  SQLState, int vendorCode, int[] updateCounts)
          Constructs a fully-specified BatchUpdateException object, initializing it with the given values.
 
Method Summary
 int[] getUpdateCounts sample code for java.sql.BatchUpdateException.getUpdateCounts() definition code for java.sql.BatchUpdateException.getUpdateCounts() ()
          Retrieves the update count for each update statement in the batch update that executed successfully before this exception occurred.
 
Methods inherited from class java.sql.SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
getErrorCode sample code for java.sql.SQLException.getErrorCode() definition code for java.sql.SQLException.getErrorCode() , getNextException sample code for java.sql.SQLException.getNextException() definition code for java.sql.SQLException.getNextException() , getSQLState sample code for java.sql.SQLException.getSQLState() definition code for java.sql.SQLException.getSQLState() , setNextException sample code for java.sql.SQLException.setNextException(java.sql.SQLException) definition code for java.sql.SQLException.setNextException(java.sql.SQLException)
 
Methods inherited from class java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable
fillInStackTrace sample code for java.lang.Throwable.fillInStackTrace() definition code for java.lang.Throwable.fillInStackTrace() , getCause sample code for java.lang.Throwable.getCause() definition code for java.lang.Throwable.getCause() , getLocalizedMessage sample code for java.lang.Throwable.getLocalizedMessage() definition code for java.lang.Throwable.getLocalizedMessage() , getMessage sample code for java.lang.Throwable.getMessage() definition code for java.lang.Throwable.getMessage() , getStackTrace sample code for java.lang.Throwable.getStackTrace() definition code for java.lang.Throwable.getStackTrace() , initCause sample code for java.lang.Throwable.initCause(java.lang.Throwable) definition code for java.lang.Throwable.initCause(java.lang.Throwable) , printStackTrace sample code for java.lang.Throwable.printStackTrace() definition code for java.lang.Throwable.printStackTrace() , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintStream) definition code for java.lang.Throwable.printStackTrace(java.io.PrintStream) , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) definition code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) , setStackTrace sample code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) definition code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) , toString sample code for java.lang.Throwable.toString() definition code for java.lang.Throwable.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

BatchUpdateException sample code for java.sql.BatchUpdateException(java.lang.String, java.lang.String, int, int[]) definition code for java.sql.BatchUpdateException(java.lang.String, java.lang.String, int, int[])

public BatchUpdateException(String sample code for java.lang.String definition code for java.lang.String  reason,
                            String sample code for java.lang.String definition code for java.lang.String  SQLState,
                            int vendorCode,
                            int[] updateCounts)
Constructs a fully-specified BatchUpdateException object, initializing it with the given values.

Parameters:
reason - a description of the error
SQLState - an X/OPEN code identifying the error
vendorCode - an exception code used by a particular database vendor
updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown
Since:
1.2

BatchUpdateException sample code for java.sql.BatchUpdateException(java.lang.String, java.lang.String, int[]) definition code for java.sql.BatchUpdateException(java.lang.String, java.lang.String, int[])

public BatchUpdateException(String sample code for java.lang.String definition code for java.lang.String  reason,
                            String sample code for java.lang.String definition code for java.lang.String  SQLState,
                            int[] updateCounts)
Constructs a BatchUpdateException initialized with the given arguments (reason, SQLState, and updateCounts) and 0 for the vendor code.

Parameters:
reason - a description of the exception
SQLState - an X/OPEN code identifying the exception
updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown
Since:
1.2

BatchUpdateException sample code for java.sql.BatchUpdateException(java.lang.String, int[]) definition code for java.sql.BatchUpdateException(java.lang.String, int[])

public BatchUpdateException(String sample code for java.lang.String definition code for java.lang.String  reason,
                            int[] updateCounts)
Constructs a BatchUpdateException initialized with reason, updateCounts and null for the SQLState and 0 for the vendorCode.

Parameters:
reason - a description of the exception
updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown
Since:
1.2

BatchUpdateException sample code for java.sql.BatchUpdateException(int[]) definition code for java.sql.BatchUpdateException(int[])

public BatchUpdateException(int[] updateCounts)
Constructs a BatchUpdateException initialized to null for the reason and SQLState and 0 for the vendor code.

Parameters:
updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown
Since:
1.2

BatchUpdateException sample code for java.sql.BatchUpdateException() definition code for java.sql.BatchUpdateException()

public BatchUpdateException()
Constructs a BatchUpdateException object with the reason, SQLState, and update count initialized to null and the vendor code initialized to 0.

Since:
1.2
Method Detail

getUpdateCounts sample code for java.sql.BatchUpdateException.getUpdateCounts() definition code for java.sql.BatchUpdateException.getUpdateCounts()

public int[] getUpdateCounts()
Retrieves the update count for each update statement in the batch update that executed successfully before this exception occurred. A driver that implements batch updates may or may not continue to process the remaining commands in a batch when one of the commands fails to execute properly. If the driver continues processing commands, the array returned by this method will have as many elements as there are commands in the batch; otherwise, it will contain an update count for each command that executed successfully before the BatchUpdateException was thrown.

The possible return values for this method were modified for the Java 2 SDK, Standard Edition, version 1.3. This was done to accommodate the new option of continuing to process commands in a batch update after a BatchUpdateException object has been thrown.

Returns:
an array of int containing the update counts for the updates that were executed successfully before this error occurred. Or, if the driver continues to process commands after an error, one of the following for every command in the batch:
  1. an update count
  2. Statement.SUCCESS_NO_INFO to indicate that the command executed successfully but the number of rows affected is unknown
  3. Statement.EXECUTE_FAILED to indicate that the command failed to execute successfully
Since:
1.3