forked from bjmashibing/java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBlob.html
More file actions
729 lines (728 loc) · 33.1 KB
/
Blob.html
File metadata and controls
729 lines (728 loc) · 33.1 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
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Blob (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.sql.Blob interface">
<meta name="keywords" content="length()">
<meta name="keywords" content="getBytes()">
<meta name="keywords" content="getBinaryStream()">
<meta name="keywords" content="position()">
<meta name="keywords" content="setBytes()">
<meta name="keywords" content="setBinaryStream()">
<meta name="keywords" content="truncate()">
<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="Blob (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/Blob.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 Blob" class="title">Interface Blob</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/SerialBlob.html" title="class in javax.sql.rowset.serial">SerialBlob</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Blob</span></pre>
<div class="block">The representation (mapping) in
the Java™ programming language of an SQL
<code>BLOB</code> value. An SQL <code>BLOB</code> is a built-in type
that stores a Binary Large Object as a column value in a row of
a database table. By default drivers implement <code>Blob</code> using
an SQL <code>locator(BLOB)</code>, which means that a
<code>Blob</code> object contains a logical pointer to the
SQL <code>BLOB</code> data rather than the data itself.
A <code>Blob</code> object is valid for the duration of the
transaction in which is was created.
<P>Methods in the interfaces <a href="ResultSet.html" title="interface in java.sql"><code>ResultSet</code></a>,
<a href="CallableStatement.html" title="interface in java.sql"><code>CallableStatement</code></a>, and <a href="PreparedStatement.html" title="interface in java.sql"><code>PreparedStatement</code></a>, such as
<code>getBlob</code> and <code>setBlob</code> allow a programmer to
access an SQL <code>BLOB</code> value.
The <code>Blob</code> interface provides methods for getting the
length of an SQL <code>BLOB</code> (Binary Large Object) value,
for materializing a <code>BLOB</code> value on the client, and for
determining the position of a pattern of bytes within a
<code>BLOB</code> value. In addition, this interface has methods for updating
a <code>BLOB</code> value.
<p>
All methods on the <code>Blob</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>Blob</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/io/InputStream.html" title="class in java.io">InputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBinaryStream()">getBinaryStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the <code>BLOB</code> value designated by this
<code>Blob</code> instance as a stream.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../java.base/java/io/InputStream.html" title="class in java.io">InputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBinaryStream(long,long)">getBinaryStream</a></span>​(long pos,
long length)</code></th>
<td class="colLast">
<div class="block">Returns an <code>InputStream</code> object that contains
a partial <code>Blob</code> value, starting with the byte
specified by pos, which is length bytes in length.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytes(long,int)">getBytes</a></span>​(long pos,
int length)</code></th>
<td class="colLast">
<div class="block">Retrieves all or part of the <code>BLOB</code>
value that this <code>Blob</code> object represents, as an array of
bytes.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#length()">length</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of bytes in the <code>BLOB</code> value
designated by this <code>Blob</code> object.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position(byte%5B%5D,long)">position</a></span>​(byte[] pattern,
long start)</code></th>
<td class="colLast">
<div class="block">Retrieves the byte position at which the specified byte array
<code>pattern</code> begins within the <code>BLOB</code>
value that this <code>Blob</code> object represents.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position(java.sql.Blob,long)">position</a></span>​(<a href="Blob.html" title="interface in java.sql">Blob</a> pattern,
long start)</code></th>
<td class="colLast">
<div class="block">Retrieves the byte position in the <code>BLOB</code> value
designated by this <code>Blob</code> object at which
<code>pattern</code> begins.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="../../../java.base/java/io/OutputStream.html" title="class in java.io">OutputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBinaryStream(long)">setBinaryStream</a></span>​(long pos)</code></th>
<td class="colLast">
<div class="block">Retrieves a stream that can be used to write to the <code>BLOB</code>
value that this <code>Blob</code> object represents.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBytes(long,byte%5B%5D)">setBytes</a></span>​(long pos,
byte[] bytes)</code></th>
<td class="colLast">
<div class="block">Writes the given array of bytes to the <code>BLOB</code> value that
this <code>Blob</code> object represents, starting at position
<code>pos</code>, and returns the number of bytes written.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBytes(long,byte%5B%5D,int,int)">setBytes</a></span>​(long pos,
byte[] bytes,
int offset,
int len)</code></th>
<td class="colLast">
<div class="block">Writes all or part of the given <code>byte</code> array to the
<code>BLOB</code> value that this <code>Blob</code> object represents
and returns the number of bytes written.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#truncate(long)">truncate</a></span>​(long len)</code></th>
<td class="colLast">
<div class="block">Truncates the <code>BLOB</code> value that this <code>Blob</code>
object represents to be <code>len</code> bytes in length.</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="length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>length</h4>
<pre class="methodSignature">long length()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Returns the number of bytes in the <code>BLOB</code> value
designated by this <code>Blob</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>length of the <code>BLOB</code> in bytes</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
length of the <code>BLOB</code></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="getBytes(long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre class="methodSignature">byte[] getBytes​(long pos,
int length)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves all or part of the <code>BLOB</code>
value that this <code>Blob</code> object represents, as an array of
bytes. This <code>byte</code> array contains up to <code>length</code>
consecutive bytes starting at position <code>pos</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the ordinal position of the first byte in the
<code>BLOB</code> value to be extracted; the first byte is at
position 1</dd>
<dd><code>length</code> - the number of consecutive bytes to be copied; the value
for length must be 0 or greater</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a byte array containing up to <code>length</code>
consecutive bytes from the <code>BLOB</code> value designated
by this <code>Blob</code> object, starting with the
byte at position <code>pos</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value; if pos is less than 1 or length is
less than 0</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setBytes(long,byte%5B%5D)"><code>setBytes(long, byte[])</code></a></dd>
</dl>
</li>
</ul>
<a id="getBinaryStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBinaryStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/InputStream.html" title="class in java.io">InputStream</a> getBinaryStream()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the <code>BLOB</code> value designated by this
<code>Blob</code> instance as a stream.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a stream containing the <code>BLOB</code> data</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setBinaryStream(long)"><code>setBinaryStream(long)</code></a></dd>
</dl>
</li>
</ul>
<a id="position(byte[],long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre class="methodSignature">long position​(byte[] pattern,
long start)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the byte position at which the specified byte array
<code>pattern</code> begins within the <code>BLOB</code>
value that this <code>Blob</code> object represents.
The search for <code>pattern</code> begins at position
<code>start</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the byte array for which to search</dd>
<dd><code>start</code> - the position at which to begin searching; the
first position is 1</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the position at which the pattern appears, else -1</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> or if start is less than 1</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="position(java.sql.Blob,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre class="methodSignature">long position​(<a href="Blob.html" title="interface in java.sql">Blob</a> pattern,
long start)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the byte position in the <code>BLOB</code> value
designated by this <code>Blob</code> object at which
<code>pattern</code> begins. The search begins at position
<code>start</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - the <code>Blob</code> object designating
the <code>BLOB</code> value for which to search</dd>
<dd><code>start</code> - the position in the <code>BLOB</code> value
at which to begin searching; the first position is 1</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the position at which the pattern begins, else -1</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value or if start is less than 1</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="setBytes(long,byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre class="methodSignature">int setBytes​(long pos,
byte[] bytes)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Writes the given array of bytes to the <code>BLOB</code> value that
this <code>Blob</code> object represents, starting at position
<code>pos</code>, and returns the number of bytes written.
The array of bytes will overwrite the existing bytes
in the <code>Blob</code> object starting at the position
<code>pos</code>. If the end of the <code>Blob</code> value is reached
while writing the array of bytes, then the length of the <code>Blob</code>
value will be increased to accommodate the extra bytes.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>BLOB</code> value then the
behavior is undefined. Some JDBC drivers may throw an
<code>SQLException</code> while other drivers may support this
operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the position in the <code>BLOB</code> object at which
to start writing; the first position is 1</dd>
<dd><code>bytes</code> - the array of bytes to be written to the <code>BLOB</code>
value that this <code>Blob</code> object represents</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value or if pos is less than 1</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.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getBytes(long,int)"><code>getBytes(long, int)</code></a></dd>
</dl>
</li>
</ul>
<a id="setBytes(long,byte[],int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre class="methodSignature">int setBytes​(long pos,
byte[] bytes,
int offset,
int len)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Writes all or part of the given <code>byte</code> array to the
<code>BLOB</code> value that this <code>Blob</code> object represents
and returns the number of bytes written.
Writing starts at position <code>pos</code> in the <code>BLOB</code>
value; <code>len</code> bytes from the given byte array are written.
The array of bytes will overwrite the existing bytes
in the <code>Blob</code> object starting at the position
<code>pos</code>. If the end of the <code>Blob</code> value is reached
while writing the array of bytes, then the length of the <code>Blob</code>
value will be increased to accommodate the extra bytes.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>BLOB</code> value then the
behavior is undefined. Some JDBC drivers may throw an
<code>SQLException</code> while other drivers may support this
operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the position in the <code>BLOB</code> object at which
to start writing; the first position is 1</dd>
<dd><code>bytes</code> - the array of bytes to be written to this <code>BLOB</code>
object</dd>
<dd><code>offset</code> - the offset into the array <code>bytes</code> at which
to start reading the bytes to be set</dd>
<dd><code>len</code> - the number of bytes to be written to the <code>BLOB</code>
value from the array of bytes <code>bytes</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value or if pos is less than 1</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.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getBytes(long,int)"><code>getBytes(long, int)</code></a></dd>
</dl>
</li>
</ul>
<a id="setBinaryStream(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBinaryStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/OutputStream.html" title="class in java.io">OutputStream</a> setBinaryStream​(long pos)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a stream that can be used to write to the <code>BLOB</code>
value that this <code>Blob</code> object represents. The stream begins
at position <code>pos</code>.
The bytes written to the stream will overwrite the existing bytes
in the <code>Blob</code> object starting at the position
<code>pos</code>. If the end of the <code>Blob</code> value is reached
while writing to the stream, then the length of the <code>Blob</code>
value will be increased to accommodate the extra bytes.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>BLOB</code> value then the
behavior is undefined. Some JDBC drivers may throw an
<code>SQLException</code> while other drivers may support this
operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the position in the <code>BLOB</code> value at which
to start writing; the first position is 1</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>java.io.OutputStream</code> object to which data can
be written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value or if pos is less than 1</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.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getBinaryStream()"><code>getBinaryStream()</code></a></dd>
</dl>
</li>
</ul>
<a id="truncate(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truncate</h4>
<pre class="methodSignature">void truncate​(long len)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Truncates the <code>BLOB</code> value that this <code>Blob</code>
object represents to be <code>len</code> bytes in length.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>BLOB</code> value then the
behavior is undefined. Some JDBC drivers may throw an
<code>SQLException</code> while other drivers may support this
operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>len</code> - the length, in bytes, to which the <code>BLOB</code> value
that this <code>Blob</code> object represents should be truncated</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error accessing the
<code>BLOB</code> value or if len is less than 0</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.4</dd>
</dl>
</li>
</ul>
<a id="free()">
<!-- -->
</a>
<ul class="blockList">
<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>Blob</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 an <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 Blob'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>
<a id="getBinaryStream(long,long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBinaryStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/InputStream.html" title="class in java.io">InputStream</a> getBinaryStream​(long pos,
long length)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Returns an <code>InputStream</code> object that contains
a partial <code>Blob</code> value, starting with the byte
specified by pos, which is length bytes in length.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the offset to the first byte of the partial value to be
retrieved. The first byte in the <code>Blob</code> is at position 1.</dd>
<dd><code>length</code> - the length in bytes of the partial value to be retrieved</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>InputStream</code> through which
the partial <code>Blob</code> value can be read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if pos is less than 1 or if pos is greater
than the number of bytes in the <code>Blob</code> or if
pos + length is greater than the number of bytes
in the <code>Blob</code></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/Blob.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>