1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
/* PreparedStatement.java -- Interface for pre-compiled statements.
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;
import java.io.InputStream;
import java.io.Reader;
import java.math.BigDecimal;
/**
* This interface provides a mechanism for executing pre-compiled
* statements. This provides greater efficiency when calling the same
* statement multiple times. Parameters are allowed in a statement,
* providings for maximum reusability.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface PreparedStatement extends Statement
{
/**
* This method populates the specified parameter with a SQL NULL value
* for the specified type.
*
* @param index The index of the parameter to set.
* @param type The SQL type identifier of the parameter from <code>Types</code>
*
* @exception SQLException If an error occurs.
*/
public abstract void
setNull(int index, int type) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>boolean</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setBoolean(int index, boolean value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>byte</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setByte(int index, byte value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>short</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setShort(int index, short value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>int</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setInt(int index, int value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>long</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setLong(int index, long value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>float</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setFloat(int index, float value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>double</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setDouble(int index, double value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>String</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setString(int index, String value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>byte</code> array value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setBytes(int index, byte[] value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>java.math.BigDecimal</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setBigDecimal(int index, java.math.BigDecimal value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>java.sql.Date</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setDate(int index, java.sql.Date value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>java.sql.Time</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setTime(int index, java.sql.Time value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>java.sql.Timestamp</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setTimestamp(int index, java.sql.Timestamp value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* ASCII <code>InputStream</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
* @param length The number of bytes in the stream.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setAsciiStream(int index, InputStream value, int length) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* Unicode UTF-8 <code>InputStream</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
* @param length The number of bytes in the stream.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setUnicodeStream(int index, InputStream value, int length) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* binary <code>InputStream</code> value.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
* @param length The number of bytes in the stream.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setBinaryStream(int index, InputStream value, int length) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>Object</code> value. The default object type to SQL type mapping
* will be used.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
*
* @exception SQLException If an error occurs.
*/
public abstract void
setObject(int index, Object value) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>Object</code> value. The specified SQL object type will be used.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
* @param type The SQL type to use for the parameter, from <code>Types</code>
*
* @exception SQLException If an error occurs.
*
* @see Types
*/
public abstract void
setObject(int index, Object value, int type) throws SQLException;
/*************************************************************************/
/**
* This method sets the specified parameter from the given Java
* <code>Object</code> value. The specified SQL object type will be used.
*
* @param index The index of the parameter value to set.
* @param value The value of the parameter.
* @param type The SQL type to use for the parameter, from <code>Types</code>
* @param scale The scale of the value, for numeric values only.
*
* @exception SQLException If an error occurs.
*
* @see Types
*/
public abstract void
setObject(int index, Object value, int type, int scale) throws SQLException;
/*************************************************************************/
/**
* This method clears all of the input parameter that have been
* set on this statement.
*
* @exception SQLException If an error occurs.
*/
public abstract void
clearParameters() throws SQLException;
/*************************************************************************/
/**
* This method executes a prepared SQL query.
* Some prepared statements return multiple results; the execute method
* handles these complex statements as well as the simpler form of
* statements handled by executeQuery and executeUpdate.
*
* @return The result of the SQL statement.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
execute() throws SQLException;
/*************************************************************************/
/**
* This method executes a prepared SQL query and returns its ResultSet.
*
* @return The ResultSet of the SQL statement.
*
* @exception SQLException If an error occurs.
*/
public abstract ResultSet
executeQuery() throws SQLException;
/*************************************************************************/
/**
* This method executes an SQL INSERT, UPDATE or DELETE statement. SQL
* statements that return nothing such as SQL DDL statements can be executed.
*
* @return The result is either the row count for INSERT, UPDATE or DELETE
* statements; or 0 for SQL statements that return nothing.
*
* @exception SQLException If an error occurs.
*/
public abstract int
executeUpdate() throws SQLException;
} // interface PreparedStatement
|
