TransactionLogIterator

java.lang.Object
- org.rocksdb.AbstractNativeReference
- - org.rocksdb.AbstractImmutableNativeReference
  - - org.rocksdb.RocksObject
    - - org.rocksdb.TransactionLogIterator

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class TransactionLogIterator
extends RocksObject
```
A TransactionLogIterator is used to iterate over the transactions in a db. One run of the iterator is continuous, i.e. the iterator will stop at the beginning of any gap in sequences.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`TransactionLogIterator.BatchResult`	BatchResult represents a data structure returned by a TransactionLogIterator containing a sequence number and a `WriteBatch` instance.

Field Summary
- Fields inherited from class org.rocksdb.RocksObject
  nativeHandle_
- Fields inherited from class org.rocksdb.AbstractImmutableNativeReference
  owningHandle_

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`disposeInternal(long handle)`
`TransactionLogIterator.BatchResult`	`getBatch()`	If iterator position is valid, return the current write_batch and the sequence number of the earliest transaction contained in the batch.
`boolean`	`isValid()`	An iterator is either positioned at a WriteBatch or not valid.
`void`	`next()`	Moves the iterator to the next WriteBatch.
`void`	`status()`	Throws RocksDBException if something went wrong.

Methods inherited from class org.rocksdb.RocksObject
disposeInternal, getNativeHandle

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference
close, disOwnNativeHandle, isOwningHandle

Methods inherited from class org.rocksdb.AbstractNativeReference
dispose, finalize

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isValid
```
public boolean isValid()
```
    An iterator is either positioned at a WriteBatch or not valid. This method returns true if the iterator is valid. Can read data from a valid iterator.
    
    Returns:
    
    true if iterator position is valid.
  - next
```
public void next()
```
    Moves the iterator to the next WriteBatch. REQUIRES: Valid() to be true.
  - status
```
public void status()
            throws RocksDBException
```
    Throws RocksDBException if something went wrong.
    
    Throws:
    
    RocksDBException - if something went wrong in the underlying C++ code.
  - getBatch
```
public TransactionLogIterator.BatchResult getBatch()
```
    If iterator position is valid, return the current write_batch and the sequence number of the earliest transaction contained in the batch.
    
    ONLY use if Valid() is true and status() is OK.
    
    Returns:
    
    TransactionLogIterator.BatchResult instance.
  - disposeInternal
```
protected final void disposeInternal(long handle)
```
    Specified by:
    
    disposeInternal in class RocksObject