Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Expand file tree

/

Clob.html

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
815 lines (815 loc) · 37.9 KB
/

Clob.html

File metadata and controls

815 lines (815 loc) · 37.9 KB
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Clob (Java SE 12 &amp; JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.sql.Clob interface">
<meta name="keywords" content="length()">
<meta name="keywords" content="getSubString()">
<meta name="keywords" content="getCharacterStream()">
<meta name="keywords" content="getAsciiStream()">
<meta name="keywords" content="position()">
<meta name="keywords" content="setString()">
<meta name="keywords" content="setAsciiStream()">
<meta name="keywords" content="setCharacterStream()">
<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="Clob (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,"i11":6,"i12":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/Clob.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 &amp; JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="../../module-summary.html">java.sql</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">java.sql</a></div>
<h2 title="Interface Clob" class="title">Interface Clob</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="NClob.html" title="interface in java.sql">NClob</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../java.sql.rowset/javax/sql/rowset/serial/SerialClob.html" title="class in javax.sql.rowset.serial">SerialClob</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Clob</span></pre>
<div class="block">The mapping in the Java&trade; programming language
for the SQL <code>CLOB</code> type.
An SQL <code>CLOB</code> is a built-in type
that stores a Character Large Object as a column value in a row of
a database table.
By default drivers implement a <code>Clob</code> object using an SQL
<code>locator(CLOB)</code>, which means that a <code>Clob</code> object
contains a logical pointer to the SQL <code>CLOB</code> data rather than
the data itself. A <code>Clob</code> object is valid for the duration
of the transaction in which it was created.
<P>The <code>Clob</code> interface provides methods for getting the
length of an SQL <code>CLOB</code> (Character Large Object) value,
for materializing a <code>CLOB</code> value on the client, and for
searching for a substring or <code>CLOB</code> object within a
<code>CLOB</code> value.
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>getClob</code> and <code>setClob</code> allow a programmer to
access an SQL <code>CLOB</code> value. In addition, this interface
has methods for updating a <code>CLOB</code> value.
<p>
All methods on the <code>Clob</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 releases the resources that the <code>Clob</code> object
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="#getAsciiStream()">getAsciiStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the <code>CLOB</code> value designated by this <code>Clob</code>
object as an ascii stream.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../java.base/java/io/Reader.html" title="class in java.io">Reader</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharacterStream()">getCharacterStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the <code>CLOB</code> value designated by this <code>Clob</code>
object as a <code>java.io.Reader</code> object (or as a stream of
characters).</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../java.base/java/io/Reader.html" title="class in java.io">Reader</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharacterStream(long,long)">getCharacterStream</a></span>&#8203;(long&nbsp;pos,
long&nbsp;length)</code></th>
<td class="colLast">
<div class="block">Returns a <code>Reader</code> object that contains
a partial <code>Clob</code> value, starting with the character
specified by pos, which is length characters in length.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<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="#getSubString(long,int)">getSubString</a></span>&#8203;(long&nbsp;pos,
int&nbsp;length)</code></th>
<td class="colLast">
<div class="block">Retrieves a copy of the specified substring
in the <code>CLOB</code> value
designated by this <code>Clob</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="#length()">length</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves the number of characters
in the <code>CLOB</code> value
designated by this <code>Clob</code> object.</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.lang.String,long)">position</a></span>&#8203;(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;searchstr,
long&nbsp;start)</code></th>
<td class="colLast">
<div class="block">Retrieves the character position at which the specified substring
<code>searchstr</code> appears in the SQL <code>CLOB</code> value
represented by this <code>Clob</code> object.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position(java.sql.Clob,long)">position</a></span>&#8203;(<a href="Clob.html" title="interface in java.sql">Clob</a>&nbsp;searchstr,
long&nbsp;start)</code></th>
<td class="colLast">
<div class="block">Retrieves the character position at which the specified
<code>Clob</code> object <code>searchstr</code> appears in this
<code>Clob</code> object.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<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="#setAsciiStream(long)">setAsciiStream</a></span>&#8203;(long&nbsp;pos)</code></th>
<td class="colLast">
<div class="block">Retrieves a stream to be used to write Ascii characters to the
<code>CLOB</code> value that this <code>Clob</code> object represents,
starting at position <code>pos</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code><a href="../../../java.base/java/io/Writer.html" title="class in java.io">Writer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCharacterStream(long)">setCharacterStream</a></span>&#8203;(long&nbsp;pos)</code></th>
<td class="colLast">
<div class="block">Retrieves a stream to be used to write a stream of Unicode characters
to the <code>CLOB</code> value that this <code>Clob</code> object
represents, at position <code>pos</code>.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setString(long,java.lang.String)">setString</a></span>&#8203;(long&nbsp;pos,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)</code></th>
<td class="colLast">
<div class="block">Writes the given Java <code>String</code> to the <code>CLOB</code>
value that this <code>Clob</code> object designates at the position
<code>pos</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setString(long,java.lang.String,int,int)">setString</a></span>&#8203;(long&nbsp;pos,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;str,
int&nbsp;offset,
int&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Writes <code>len</code> characters of <code>str</code>, starting
at character <code>offset</code>, to the <code>CLOB</code> value
that this <code>Clob</code> represents.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#truncate(long)">truncate</a></span>&#8203;(long&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Truncates the <code>CLOB</code> value that this <code>Clob</code>
designates to have a length of <code>len</code>
characters.</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&nbsp;length()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the number of characters
in the <code>CLOB</code> value
designated by this <code>Clob</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>length of the <code>CLOB</code> in characters</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>CLOB</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>
</dl>
</li>
</ul>
<a id="getSubString(long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubString</h4>
<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;getSubString&#8203;(long&nbsp;pos,
int&nbsp;length)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a copy of the specified substring
in the <code>CLOB</code> value
designated by this <code>Clob</code> object.
The substring begins at position
<code>pos</code> and has up to <code>length</code> consecutive
characters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the first character of the substring to be extracted.
The first character is at position 1.</dd>
<dd><code>length</code> - the number of consecutive characters to be copied;
the value for length must be 0 or greater</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>String</code> that is the specified substring in
the <code>CLOB</code> value designated by this <code>Clob</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 there is an error accessing the
<code>CLOB</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>
</dl>
</li>
</ul>
<a id="getCharacterStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharacterStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/Reader.html" title="class in java.io">Reader</a>&nbsp;getCharacterStream()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the <code>CLOB</code> value designated by this <code>Clob</code>
object as a <code>java.io.Reader</code> object (or as a stream of
characters).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>java.io.Reader</code> object containing the
<code>CLOB</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>CLOB</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="#setCharacterStream(long)"><code>setCharacterStream(long)</code></a></dd>
</dl>
</li>
</ul>
<a id="getAsciiStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsciiStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/InputStream.html" title="class in java.io">InputStream</a>&nbsp;getAsciiStream()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the <code>CLOB</code> value designated by this <code>Clob</code>
object as an ascii stream.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>java.io.InputStream</code> object containing the
<code>CLOB</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>CLOB</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="#setAsciiStream(long)"><code>setAsciiStream(long)</code></a></dd>
</dl>
</li>
</ul>
<a id="position(java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre class="methodSignature">long&nbsp;position&#8203;(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;searchstr,
long&nbsp;start)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the character position at which the specified substring
<code>searchstr</code> appears in the SQL <code>CLOB</code> value
represented by this <code>Clob</code> object. The search
begins at position <code>start</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>searchstr</code> - the substring 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 substring appears or -1 if it is not
present; the first position is 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>CLOB</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.2</dd>
</dl>
</li>
</ul>
<a id="position(java.sql.Clob,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre class="methodSignature">long&nbsp;position&#8203;(<a href="Clob.html" title="interface in java.sql">Clob</a>&nbsp;searchstr,
long&nbsp;start)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves the character position at which the specified
<code>Clob</code> object <code>searchstr</code> appears in this
<code>Clob</code> object. The search begins at position
<code>start</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>searchstr</code> - the <code>Clob</code> object 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 <code>Clob</code> object appears
or -1 if it is not present; the first position is 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>CLOB</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="setString(long,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setString</h4>
<pre class="methodSignature">int&nbsp;setString&#8203;(long&nbsp;pos,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;str)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Writes the given Java <code>String</code> to the <code>CLOB</code>
value that this <code>Clob</code> object designates at the position
<code>pos</code>. The string will overwrite the existing characters
in the <code>Clob</code> object starting at the position
<code>pos</code>. If the end of the <code>Clob</code> value is reached
while writing the given string, then the length of the <code>Clob</code>
value will be increased to accommodate the extra characters.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>CLOB</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 at which to start writing to the <code>CLOB</code>
value that this <code>Clob</code> object represents;
the first position is 1.</dd>
<dd><code>str</code> - the string to be written to the <code>CLOB</code>
value that this <code>Clob</code> designates</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of characters 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>CLOB</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>
</dl>
</li>
</ul>
<a id="setString(long,java.lang.String,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setString</h4>
<pre class="methodSignature">int&nbsp;setString&#8203;(long&nbsp;pos,
<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a>&nbsp;str,
int&nbsp;offset,
int&nbsp;len)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Writes <code>len</code> characters of <code>str</code>, starting
at character <code>offset</code>, to the <code>CLOB</code> value
that this <code>Clob</code> represents.
The string will overwrite the existing characters
in the <code>Clob</code> object starting at the position
<code>pos</code>. If the end of the <code>Clob</code> value is reached
while writing the given string, then the length of the <code>Clob</code>
value will be increased to accommodate the extra characters.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>CLOB</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 at which to start writing to this
<code>CLOB</code> object; The first position is 1</dd>
<dd><code>str</code> - the string to be written to the <code>CLOB</code>
value that this <code>Clob</code> object represents</dd>
<dd><code>offset</code> - the offset into <code>str</code> to start reading
the characters to be written</dd>
<dd><code>len</code> - the number of characters to be written</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of characters 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>CLOB</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>
</dl>
</li>
</ul>
<a id="setAsciiStream(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAsciiStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/OutputStream.html" title="class in java.io">OutputStream</a>&nbsp;setAsciiStream&#8203;(long&nbsp;pos)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a stream to be used to write Ascii characters to the
<code>CLOB</code> value that this <code>Clob</code> object represents,
starting at position <code>pos</code>. Characters written to the stream
will overwrite the existing characters
in the <code>Clob</code> object starting at the position
<code>pos</code>. If the end of the <code>Clob</code> value is reached
while writing characters to the stream, then the length of the <code>Clob</code>
value will be increased to accommodate the extra characters.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>CLOB</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 at which to start writing to this
<code>CLOB</code> object; The first position is 1</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the stream to which ASCII encoded characters 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>CLOB</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="#getAsciiStream()"><code>getAsciiStream()</code></a></dd>
</dl>
</li>
</ul>
<a id="setCharacterStream(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCharacterStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/Writer.html" title="class in java.io">Writer</a>&nbsp;setCharacterStream&#8203;(long&nbsp;pos)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Retrieves a stream to be used to write a stream of Unicode characters
to the <code>CLOB</code> value that this <code>Clob</code> object
represents, at position <code>pos</code>. Characters written to the stream
will overwrite the existing characters
in the <code>Clob</code> object starting at the position
<code>pos</code>. If the end of the <code>Clob</code> value is reached
while writing characters to the stream, then the length of the <code>Clob</code>
value will be increased to accommodate the extra characters.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>CLOB</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 at which to start writing to the
<code>CLOB</code> value; The first position is 1</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a stream to which Unicode encoded characters 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>CLOB</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="#getCharacterStream()"><code>getCharacterStream()</code></a></dd>
</dl>
</li>
</ul>
<a id="truncate(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truncate</h4>
<pre class="methodSignature">void&nbsp;truncate&#8203;(long&nbsp;len)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Truncates the <code>CLOB</code> value that this <code>Clob</code>
designates to have a length of <code>len</code>
characters.
<p>
<b>Note:</b> If the value specified for <code>pos</code>
is greater than the length+1 of the <code>CLOB</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 characters, to which the <code>CLOB</code> value
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>CLOB</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&nbsp;free()
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">This method releases the resources that the <code>Clob</code> object
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 Clob'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="getCharacterStream(long,long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCharacterStream</h4>
<pre class="methodSignature"><a href="../../../java.base/java/io/Reader.html" title="class in java.io">Reader</a>&nbsp;getCharacterStream&#8203;(long&nbsp;pos,
long&nbsp;length)
throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>
<div class="block">Returns a <code>Reader</code> object that contains
a partial <code>Clob</code> value, starting with the character
specified by pos, which is length characters in length.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - the offset to the first character of the partial value to
be retrieved. The first character in the Clob is at position 1.</dd>
<dd><code>length</code> - the length in characters of the partial value to be retrieved.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Reader</code> through which
the partial <code>Clob</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 characters
in the <code>Clob</code>;
or if pos + length is greater than the number of
characters in the <code>Clob</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/Clob.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 &amp; JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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&amp;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> &copy; 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>
Morty Proxy This is a proxified and sanitized view of the page, visit original site.