forked from bjmashibing/java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathArray.html
More file actions
780 lines (780 loc) · 37.8 KB
/
Array.html
File metadata and controls
780 lines (780 loc) · 37.8 KB
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Array (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.sql.Array interface">
<meta name="keywords" content="getBaseTypeName()">
<meta name="keywords" content="getBaseType()">
<meta name="keywords" content="getArray()">
<meta name="keywords" content="getResultSet()">
<meta name="keywords" content="free()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Array (Java SE 12 & JDK 12 )";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Array.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.sql</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.sql</a></div>
<h2 title="Interface Array" class="title">Interface Array</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../java.sql.rowset/javax/sql/rowset/serial/SerialArray.html" title="class in javax.sql.rowset.serial">SerialArray</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Array</span></pre>
<div class="block">The mapping in the Java programming language for the SQL type
<code>ARRAY</code>.
By default, an <code>Array</code> value is a transaction-duration
reference to an SQL <code>ARRAY</code> value. By default, an <code>Array</code>
object is implemented using an SQL LOCATOR(array) internally, which
means that an <code>Array</code> object contains a logical pointer
to the data in the SQL <code>ARRAY</code> value rather
than containing the <code>ARRAY</code> value's data.
<p>
The <code>Array</code> interface provides methods for bringing an SQL
<code>ARRAY</code> value's data to the client as either an array or a
<code>ResultSet</code> object.
If the elements of the SQL <code>ARRAY</code>
are a UDT, they may be custom mapped. To create a custom mapping,
a programmer must do two things:
<ul>
<li>create a class that implements the <a href="SQLData.html" title="interface in java.sql"><code>SQLData</code></a>
interface for the UDT to be custom mapped.
<li>make an entry in a type map that contains
<ul>
<li>the fully-qualified SQL type name of the UDT
<li>the <code>Class</code> object for the class implementing
<code>SQLData</code>
</ul>
</ul>
<p>
When a type map with an entry for
the base type is supplied to the methods <code>getArray</code>
and <code>getResultSet</code>, the mapping
it contains will be used to map the elements of the <code>ARRAY</code> value.
If no type map is supplied, which would typically be the case,
the connection's type map is used by default.
If the connection's type map or a type map supplied to a method has no entry
for the base type, the elements are mapped according to the standard mapping.
<p>
All methods on the <code>Array</code> interface must be fully implemented if the
JDBC driver supports the data type.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#free()">free</a></span>()</code></th>
<td class="colLast">
<div class="block">This method frees the <code>Array</code> object and releases the resources that
it holds.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArray()">getArray</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the contents of the SQL <code>ARRAY</code> value designated
by this
<code>Array</code> object in the form of an array in the Java
programming language.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArray(long,int)">getArray</a></span>​(long index,
int count)</code></th>
<td class="colLast">
<div class="block">Retrieves a slice of the SQL <code>ARRAY</code>
value designated by this <code>Array</code> object, beginning with the
specified <code>index</code> and containing up to <code>count</code>
successive elements of the SQL array.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArray(long,int,java.util.Map)">getArray</a></span>​(long index,
int count,
<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)</code></th>
<td class="colLast">
<div class="block">Retrieves a slice of the SQL <code>ARRAY</code> value
designated by this <code>Array</code> object, beginning with the specified
<code>index</code> and containing up to <code>count</code>
successive elements of the SQL array.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArray(java.util.Map)">getArray</a></span>​(<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)</code></th>
<td class="colLast">
<div class="block">Retrieves the contents of the SQL <code>ARRAY</code> value designated by this
<code>Array</code> object.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBaseType()">getBaseType</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the JDBC type of the elements in the array designated
by this <code>Array</code> object.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBaseTypeName()">getBaseTypeName</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the SQL type name of the elements in
the array designated by this <code>Array</code> object.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="ResultSet.html" title="interface in java.sql">ResultSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultSet()">getResultSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves a result set that contains the elements of the SQL
<code>ARRAY</code> value
designated by this <code>Array</code> object.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="ResultSet.html" title="interface in java.sql">ResultSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultSet(long,int)">getResultSet</a></span>​(long index,
int count)</code></th>
<td class="colLast">
<div class="block">Retrieves a result set holding the elements of the subarray that
starts at index <code>index</code> and contains up to
<code>count</code> successive elements.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code><a href="ResultSet.html" title="interface in java.sql">ResultSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultSet(long,int,java.util.Map)">getResultSet</a></span>​(long index,
int count,
<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)</code></th>
<td class="colLast">
<div class="block">Retrieves a result set holding the elements of the subarray that
starts at index <code>index</code> and contains up to
<code>count</code> successive elements.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code><a href="ResultSet.html" title="interface in java.sql">ResultSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultSet(java.util.Map)">getResultSet</a></span>​(<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)</code></th>
<td class="colLast">
<div class="block">Retrieves a result set that contains the elements of the SQL
<code>ARRAY</code> value designated by this <code>Array</code> object.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getBaseTypeName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseTypeName</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getBaseTypeName()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the SQL type name of the elements in
the array designated by this <code>Array</code> object.
If the elements are a built-in type, it returns
the database-specific type name of the elements.
If the elements are a user-defined type (UDT),
this method returns the fully-qualified SQL type name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>String</code> that is the database-specific
name for a built-in base type; or the fully-qualified SQL type
name for a base type that is a UDT</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting
to access the type name</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getBaseType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseType</h4>
<pre class="methodSignature">int getBaseType()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the JDBC type of the elements in the array designated
by this <code>Array</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a constant from the class <a href="Types.html" title="class in java.sql"><code>Types</code></a> that is
the type code for the elements in the array designated by this
<code>Array</code> object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting
to access the base type</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArray</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a> getArray()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the contents of the SQL <code>ARRAY</code> value designated
by this
<code>Array</code> object in the form of an array in the Java
programming language. This version of the method <code>getArray</code>
uses the type map associated with the connection for customizations of
the type mappings.
<p>
<strong>Note:</strong> When <code>getArray</code> is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of <code>Object</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array in the Java programming language that contains
the ordered elements of the SQL <code>ARRAY</code> value
designated by this <code>Array</code> object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getArray(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArray</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a> getArray​(<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the contents of the SQL <code>ARRAY</code> value designated by this
<code>Array</code> object.
This method uses
the specified <code>map</code> for type map customizations
unless the base type of the array does not match a user-defined
type in <code>map</code>, in which case it
uses the standard mapping. This version of the method
<code>getArray</code> uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
<p>
<strong>Note:</strong> When <code>getArray</code> is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of <code>Object</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</code> - a <code>java.util.Map</code> object that contains mappings
of SQL type names to classes in the Java programming language</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array in the Java programming language that contains the ordered
elements of the SQL array designated by this object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getArray(long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArray</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a> getArray​(long index,
int count)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a slice of the SQL <code>ARRAY</code>
value designated by this <code>Array</code> object, beginning with the
specified <code>index</code> and containing up to <code>count</code>
successive elements of the SQL array. This method uses the type map
associated with the connection for customizations of the type mappings.
<p>
<strong>Note:</strong> When <code>getArray</code> is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of <code>Object</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the array index of the first element to retrieve;
the first element is at index 1</dd>
<dd><code>count</code> - the number of successive SQL array elements to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing up to <code>count</code> consecutive elements
of the SQL array, beginning with element <code>index</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getArray(long,int,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArray</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/Object.html" title="class in java.lang">Object</a> getArray​(long index,
int count,
<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a slice of the SQL <code>ARRAY</code> value
designated by this <code>Array</code> object, beginning with the specified
<code>index</code> and containing up to <code>count</code>
successive elements of the SQL array.
<P>
This method uses
the specified <code>map</code> for type map customizations
unless the base type of the array does not match a user-defined
type in <code>map</code>, in which case it
uses the standard mapping. This version of the method
<code>getArray</code> uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
<p>
<strong>Note:</strong> When <code>getArray</code> is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of <code>Object</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the array index of the first element to retrieve;
the first element is at index 1</dd>
<dd><code>count</code> - the number of successive SQL array elements to
retrieve</dd>
<dd><code>map</code> - a <code>java.util.Map</code> object
that contains SQL type names and the classes in
the Java programming language to which they are mapped</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing up to <code>count</code>
consecutive elements of the SQL <code>ARRAY</code> value designated by this
<code>Array</code> object, beginning with element
<code>index</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getResultSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultSet</h4>
<pre class="methodSignature"><a href="ResultSet.html" title="interface in java.sql">ResultSet</a> getResultSet()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a result set that contains the elements of the SQL
<code>ARRAY</code> value
designated by this <code>Array</code> object. If appropriate,
the elements of the array are mapped using the connection's type
map; otherwise, the standard mapping is used.
<p>
The result set contains one row for each array element, with
two columns in each row. The second column stores the element
value; the first column stores the index into the array for
that element (with the first array element being at index 1).
The rows are in ascending order corresponding to
the order of the indices.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="ResultSet.html" title="interface in java.sql"><code>ResultSet</code></a> object containing one row for each
of the elements in the array designated by this <code>Array</code>
object, with the rows in ascending order based on the indices.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getResultSet(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultSet</h4>
<pre class="methodSignature"><a href="ResultSet.html" title="interface in java.sql">ResultSet</a> getResultSet​(<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a result set that contains the elements of the SQL
<code>ARRAY</code> value designated by this <code>Array</code> object.
This method uses
the specified <code>map</code> for type map customizations
unless the base type of the array does not match a user-defined
type in <code>map</code>, in which case it
uses the standard mapping. This version of the method
<code>getResultSet</code> uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
<p>
The result set contains one row for each array element, with
two columns in each row. The second column stores the element
value; the first column stores the index into the array for
that element (with the first array element being at index 1).
The rows are in ascending order corresponding to
the order of the indices.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</code> - contains the mapping of SQL user-defined types to
classes in the Java programming language</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>ResultSet</code> object containing one row for each
of the elements in the array designated by this <code>Array</code>
object, with the rows in ascending order based on the indices.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getResultSet(long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultSet</h4>
<pre class="methodSignature"><a href="ResultSet.html" title="interface in java.sql">ResultSet</a> getResultSet​(long index,
int count)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a result set holding the elements of the subarray that
starts at index <code>index</code> and contains up to
<code>count</code> successive elements. This method uses
the connection's type map to map the elements of the array if
the map contains an entry for the base type. Otherwise, the
standard mapping is used.
<P>
The result set has one row for each element of the SQL array
designated by this object, with the first row containing the
element at index <code>index</code>. The result set has
up to <code>count</code> rows in ascending order based on the
indices. Each row has two columns: The second column stores
the element value; the first column stores the index into the
array for that element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the array index of the first element to retrieve;
the first element is at index 1</dd>
<dd><code>count</code> - the number of successive SQL array elements to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>ResultSet</code> object containing up to
<code>count</code> consecutive elements of the SQL array
designated by this <code>Array</code> object, starting at
index <code>index</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getResultSet(long,int,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultSet</h4>
<pre class="methodSignature"><a href="ResultSet.html" title="interface in java.sql">ResultSet</a> getResultSet​(long index,
int count,
<a href="../../../java.base/java/util/Map.html" title="interface in java.util">Map</a><<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>,​<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><?>> map)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a result set holding the elements of the subarray that
starts at index <code>index</code> and contains up to
<code>count</code> successive elements.
This method uses
the specified <code>map</code> for type map customizations
unless the base type of the array does not match a user-defined
type in <code>map</code>, in which case it
uses the standard mapping. This version of the method
<code>getResultSet</code> uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
<P>
The result set has one row for each element of the SQL array
designated by this object, with the first row containing the
element at index <code>index</code>. The result set has
up to <code>count</code> rows in ascending order based on the
indices. Each row has two columns: The second column stores
the element value; the first column stores the index into the
array for that element.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the array index of the first element to retrieve;
the first element is at index 1</dd>
<dd><code>count</code> - the number of successive SQL array elements to retrieve</dd>
<dd><code>map</code> - the <code>Map</code> object that contains the mapping
of SQL type names to classes in the Java(tm) programming language</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>ResultSet</code> object containing up to
<code>count</code> consecutive elements of the SQL array
designated by this <code>Array</code> object, starting at
index <code>index</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs while attempting to
access the array</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="free()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>free</h4>
<pre class="methodSignature">void free()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">This method frees the <code>Array</code> object and releases the resources that
it holds. The object is invalid once the <code>free</code>
method is called.
<p>
After <code>free</code> has been called, any attempt to invoke a
method other than <code>free</code> will result in a <code>SQLException</code>
being thrown. If <code>free</code> is called multiple times, the subsequent
calls to <code>free</code> are treated as a no-op.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if an error occurs releasing
the Array's resources</dd>
<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support
this method</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Array.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. <!-- Version 12.0.2+10 --></small></p>
</footer>
</body>
</html>