001 /* BatchUpdateException.java -- Exception for batch oriented SQL errors
002 Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package java.sql;
039
040 /**
041 * This class extends <code>SQLException</code> to count the successful
042 * updates in each statement in a batch that was successfully updated prior
043 * to the error.
044 *
045 * @author Aaron M. Renn (arenn@urbanophile.com)
046 */
047 public class BatchUpdateException extends SQLException
048 {
049 static final long serialVersionUID = 5977529877145521757L;
050
051 /**
052 * This is the array of update counts for the commands which completed
053 * successfully prior to the error.
054 */
055 private int[] updateCounts;
056
057 /**
058 * This method initializes a new instance of <code>BatchUpdateException</code>
059 * with the specified descriptive error message, SQL state, and update count
060 * information. The vendor specific error code will be initialized to 0.
061 *
062 * @param message The descriptive error message.
063 * @param SQLState The SQL state information for this error.
064 * @param vendorCode
065 * @param updateCounts The update count information for this error.
066 */
067 public BatchUpdateException(String message, String SQLState, int vendorCode,
068 int[] updateCounts)
069 {
070 super(message, SQLState, vendorCode);
071 this.updateCounts = updateCounts;
072 }
073
074 /**
075 * This method initializes a new instance of <code>BatchUpdateException</code>
076 * with the specified descriptive error message, SQL state, and update count
077 * information. The vendor specific error code will be initialized to 0.
078 *
079 * @param message The descriptive error message.
080 * @param SQLState The SQL state information for this error.
081 * @param updateCounts The update count information for this error.
082 */
083 public BatchUpdateException(String message, String SQLState,
084 int[] updateCounts)
085 {
086 super(message, SQLState);
087 this.updateCounts = updateCounts;
088 }
089
090 /**
091 * This method initializes a new instance of <code>BatchUpdateException</code>
092 * with the specified descriptive error message and update count information.
093 * The SQL state will be initialized to <code>null</code> and the vendor
094 * specific error code will be initialized to 0.
095 *
096 * @param message The descriptive error message.
097 * @param updateCounts The update count information for this error.
098 */
099 public BatchUpdateException(String message, int[] updateCounts)
100 {
101 super(message);
102 this.updateCounts = updateCounts;
103 }
104
105 /**
106 * Initializes a new instance of <code>BatchUpdateException</code>
107 * with the specified update count information and no descriptive error
108 * message. This SQL state will be initialized to <code>null</code> and
109 * the vendor specific error code will be initialized to 0.
110 *
111 * @param updateCounts The update count array.
112 */
113 public BatchUpdateException(int[] updateCounts)
114 {
115 this.updateCounts = updateCounts;
116 }
117
118 /**
119 * Initializes a new instance of <code>BatchUpdateException</code>
120 * with no descriptive error message. The SQL state and update count will
121 * be initialized to <code>null</code> and the vendor specific error code will
122 * initialized to 0.
123 */
124 public BatchUpdateException()
125 {
126 super();
127 }
128
129 /**
130 * This method returns the update count information for this error. If
131 * not <code>null</code> this is an array of <code>int</code>'s that are
132 * the update accounts for each command that was successfully executed.
133 * The array elements are in the order that the commands were executed.
134 *
135 * @return The update count information, which may be <code>null</code>.
136 */
137 public int[] getUpdateCounts()
138 {
139 return updateCounts;
140 }
141 }