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
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>RawCursor (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RawCursor (Carbonado 1.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RawCursor.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/raw/RawCursor.html" target="_top">Frames</a></li>
<li><a href="RawCursor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado.raw</div>
<h2 title="Class RawCursor" class="title">Class RawCursor<S></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.raw.RawCursor<S></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">RawCursor<S></span>
extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre>
<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.concurrent.locks.Lock</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#mLock">mLock</a></strong></code>
<div class="block">Lock object, as passed into the constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#RawCursor(java.util.concurrent.locks.Lock, byte[], boolean, byte[], boolean, int, boolean)">RawCursor</a></strong>(java.util.concurrent.locks.Lock lock,
byte[] startBound,
boolean inclusiveStart,
byte[] endBound,
boolean inclusiveEnd,
int maxPrefix,
boolean reverse)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#close()">close</a></strong>()</code>
<div class="block">Call close to release any resources being held by this cursor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#compareKeysPartially(byte[], byte[])">compareKeysPartially</a></strong>(byte[] key1,
byte[] key2)</code>
<div class="block">Returns <0 if key1 is less, 0 if equal (at least partially),
>0 if key1 is greater.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#disableKeyAndValue()">disableKeyAndValue</a></strong>()</code>
<div class="block">An optimization hint which disables key and value acquisition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#disableValue()">disableValue</a></strong>()</code>
<div class="block">An optimization hint which disables just value acquisition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#enableKeyAndValue()">enableKeyAndValue</a></strong>()</code>
<div class="block">Enable key and value acquisition again, after they have been
disabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#getCurrentKey()">getCurrentKey</a></strong>()</code>
<div class="block">Returns the contents of the current key being referenced, or null
otherwise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#getCurrentValue()">getCurrentValue</a></strong>()</code>
<div class="block">Returns the contents of the current value being referenced, or null
otherwise.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#handleNoSuchElement()">handleNoSuchElement</a></strong>()</code>
<div class="block">Called right before throwing NoSuchElementException.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#hasNext()">hasNext</a></strong>()</code>
<div class="block">Returns true if this cursor has more elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#instantiateCurrent()">instantiateCurrent</a></strong>()</code>
<div class="block">Returns a new Storable instance for the currently referenced entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#next()">next</a></strong>()</code>
<div class="block">Returns the next element from this cursor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#release()">release</a></strong>()</code>
<div class="block">Release any internal resources, called when closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code>
<div class="block">Skips forward by the specified amount of elements, returning the actual
amount skipped.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toFirst()">toFirst</a></strong>()</code>
<div class="block">Move the cursor to the first available entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toFirst(byte[])">toFirst</a></strong>(byte[] key)</code>
<div class="block">Move the cursor to the first available entry at or after the given
key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toLast()">toLast</a></strong>()</code>
<div class="block">Move the cursor to the last available entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toLast(byte[])">toLast</a></strong>(byte[] key)</code>
<div class="block">Move the cursor to the last available entry at or before the given
key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNext()">toNext</a></strong>()</code>
<div class="block">Move the cursor to the next available entry, returning false if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNext(int)">toNext</a></strong>(int amount)</code>
<div class="block">Move the cursor to the next available entry, incrementing by the amount
given.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNextKey()">toNextKey</a></strong>()</code>
<div class="block">Move the cursor to the next unique key, returning false if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPrevious()">toPrevious</a></strong>()</code>
<div class="block">Move the cursor to the previous available entry, returning false if
none.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPrevious(int)">toPrevious</a></strong>(int amount)</code>
<div class="block">Move the cursor to the previous available entry, decrementing by the
amount given.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPreviousKey()">toPreviousKey</a></strong>()</code>
<div class="block">Move the cursor to the previous unique key, returning false if none.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor">
<!-- -->
</a>
<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3>
<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="mLock">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mLock</h4>
<pre>protected final java.util.concurrent.locks.Lock mLock</pre>
<div class="block">Lock object, as passed into the constructor</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RawCursor(java.util.concurrent.locks.Lock, byte[], boolean, byte[], boolean, int, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RawCursor</h4>
<pre>protected RawCursor(java.util.concurrent.locks.Lock lock,
byte[] startBound,
boolean inclusiveStart,
byte[] endBound,
boolean inclusiveEnd,
int maxPrefix,
boolean reverse)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lock</code> - operations lock on this object</dd><dd><code>startBound</code> - specify the starting key for the cursor, or null if first</dd><dd><code>inclusiveStart</code> - true if start bound is inclusive</dd><dd><code>endBound</code> - specify the ending key for the cursor, or null if last</dd><dd><code>inclusiveEnd</code> - true if end bound is inclusive</dd><dd><code>maxPrefix</code> - maximum expected common initial bytes in start and end bound</dd><dd><code>reverse</code> - when true, iteration is reversed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if any bound is null but is not inclusive</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">Cursor</a></code></strong></div>
<div class="block">Call close to release any resources being held by this cursor. Further
operations on this cursor will behave as if there are no results.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="hasNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public boolean hasNext()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">Cursor</a></code></strong></div>
<div class="block">Returns true if this cursor has more elements. In other words, returns
true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing
an exception.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a> next()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>,
java.util.NoSuchElementException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">Cursor</a></code></strong></div>
<div class="block">Returns the next element from this cursor. This method may be called
repeatedly to iterate through the results.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd>
<dd><code>java.util.NoSuchElementException</code> - if the cursor has no next element.</dd></dl>
</li>
</ul>
<a name="skipNext(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipNext</h4>
<pre>public int skipNext(int amount)
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">Cursor</a></code></strong></div>
<div class="block">Skips forward by the specified amount of elements, returning the actual
amount skipped. The actual amount is less than the requested amount only
if the end of the results was reached.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd>
<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="release()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>release</h4>
<pre>protected abstract void release()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Release any internal resources, called when closed.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="getCurrentKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentKey</h4>
<pre>protected abstract byte[] getCurrentKey()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns the contents of the current key being referenced, or null
otherwise. Caller is responsible for making a copy of the key. The array
must not be modified concurrently.
<p>If cursor is not opened, null must be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>currently referenced key bytes or null if no current</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if key is disabled</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="getCurrentValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentValue</h4>
<pre>protected abstract byte[] getCurrentValue()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns the contents of the current value being referenced, or null
otherwise. Caller is responsible for making a copy of the value. The
array must not be modified concurrently.
<p>If cursor is not opened, null must be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>currently referenced value bytes or null if no current</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if value is disabled</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="disableKeyAndValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableKeyAndValue</h4>
<pre>protected void disableKeyAndValue()</pre>
<div class="block">An optimization hint which disables key and value acquisition. The
default implementation of this method does nothing.</div>
</li>
</ul>
<a name="disableValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableValue</h4>
<pre>protected void disableValue()</pre>
<div class="block">An optimization hint which disables just value acquisition. The default
implementation of this method does nothing.</div>
</li>
</ul>
<a name="enableKeyAndValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableKeyAndValue</h4>
<pre>protected void enableKeyAndValue()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Enable key and value acquisition again, after they have been
disabled. Calling this method forces the key and value to be
re-acquired, if they had been disabled. Key and value acquisition must
be enabled by default. The default implementation of this method does
nothing.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="instantiateCurrent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instantiateCurrent</h4>
<pre>protected abstract <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a> instantiateCurrent()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a new Storable instance for the currently referenced entry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>new Storable instance, never null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no current entry to instantiate</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toFirst</h4>
<pre>protected abstract boolean toFirst()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the first available entry. If false is returned, the
cursor must be positioned before the first available entry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if first entry exists and is now current</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toFirst(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toFirst</h4>
<pre>protected abstract boolean toFirst(byte[] key)
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the first available entry at or after the given
key. If false is returned, the cursor must be positioned before the
first available entry. Caller is responsible for preserving contents of
array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key to search for</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if first entry exists and is now current</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toLast</h4>
<pre>protected abstract boolean toLast()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the last available entry. If false is returned, the
cursor must be positioned after the last available entry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if last entry exists and is now current</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toLast(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toLast</h4>
<pre>protected abstract boolean toLast(byte[] key)
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the last available entry at or before the given
key. If false is returned, the cursor must be positioned after the last
available entry. Caller is responsible for preserving contents of array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key to search for</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if last entry exists and is now current</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toNext</h4>
<pre>protected abstract boolean toNext()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the next available entry, returning false if none. If
false is returned, the cursor must be positioned after the last
available entry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to next entry</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toNext(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toNext</h4>
<pre>protected int toNext(int amount)
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the next available entry, incrementing by the amount
given. The actual amount incremented is returned. If the amount is less
then requested, the cursor must be positioned after the last available
entry. Subclasses may wish to override this method with a faster
implementation.
<p>Calling to toNext(1) is equivalent to calling toNext().</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - positive amount to advance</dd>
<dt><span class="strong">Returns:</span></dt><dd>actual amount advanced</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toNextKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toNextKey</h4>
<pre>protected boolean toNextKey()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the next unique key, returning false if none. If
false is returned, the cursor must be positioned after the last
available entry. Subclasses may wish to override this method with a
faster implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to next unique key</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toPrevious()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPrevious</h4>
<pre>protected abstract boolean toPrevious()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the previous available entry, returning false if
none. If false is returned, the cursor must be positioned before the
first available entry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to previous entry</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toPrevious(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPrevious</h4>
<pre>protected int toPrevious(int amount)
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the previous available entry, decrementing by the
amount given. The actual amount decremented is returned. If the amount
is less then requested, the cursor must be positioned before the first
available entry. Subclasses may wish to override this method with a
faster implementation.
<p>Calling to toPrevious(1) is equivalent to calling toPrevious().</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - positive amount to retreat</dd>
<dt><span class="strong">Returns:</span></dt><dd>actual amount retreated</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="toPreviousKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPreviousKey</h4>
<pre>protected boolean toPreviousKey()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Move the cursor to the previous unique key, returning false if none. If
false is returned, the cursor must be positioned before the first
available entry. Subclasses may wish to override this method with a
faster implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to previous unique key</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="compareKeysPartially(byte[], byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareKeysPartially</h4>
<pre>protected int compareKeysPartially(byte[] key1,
byte[] key2)</pre>
<div class="block">Returns <0 if key1 is less, 0 if equal (at least partially),
>0 if key1 is greater.</div>
</li>
</ul>
<a name="handleNoSuchElement()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleNoSuchElement</h4>
<pre>protected void handleNoSuchElement()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Called right before throwing NoSuchElementException. Subclasses may
override to do special checks or throw a different exception.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RawCursor.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/raw/RawCursor.html" target="_top">Frames</a></li>
<li><a href="RawCursor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
