Package org.rocksdb

Class WBWIRocksIterator

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.AbstractRocksIterator<WriteBatchWithIndex>

org.rocksdb.WBWIRocksIterator

All Implemented Interfaces:

AutoCloseable, RocksIteratorInterface

public class WBWIRocksIterator
extends AbstractRocksIterator<WriteBatchWithIndex>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WBWIRocksIterator.WriteEntry	Represents an entry returned by entry() It is worth noting that a WriteEntry with the type WBWIRocksIterator.WriteType.DELETE or WBWIRocksIterator.WriteType.LOG will not have a value.
static enum	WBWIRocksIterator.WriteType	Enumeration of the Write operation that created the record in the Write Batch

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Fields inherited from class org.rocksdb.AbstractImmutableNativeReference

owningHandle_

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WBWIRocksIterator(WriteBatchWithIndex wbwi, long nativeHandle)

Method Summary

Modifier and Type	Method	Description
void	close()	Frees the underlying C++ object
protected final void	disposeInternal(long handle)
WBWIRocksIterator.WriteEntry	entry()	Get the current entry

Methods inherited from class org.rocksdb.AbstractRocksIterator

disposeInternal, isValid, next, prev, refresh, refresh, seek, seek, seekForPrev, seekForPrev, seekToFirst, seekToLast, status

Methods inherited from class org.rocksdb.RocksObject

getNativeHandle

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

disOwnNativeHandle, isOwningHandle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WBWIRocksIterator

protected WBWIRocksIterator(WriteBatchWithIndex wbwi,
 long nativeHandle)

Method Details

entry

public WBWIRocksIterator.WriteEntry entry()

Get the current entry

The WriteEntry is only valid until the iterator is repositioned. If you want to keep the WriteEntry across iterator movements, you must make a copy of its data!

Note - This method is not thread-safe with respect to the WriteEntry as it performs a non-atomic update across the fields of the WriteEntry

Returns:

The WriteEntry of the current entry

disposeInternal

protected final void disposeInternal(long handle)

Specified by:

disposeInternal in class RocksObject

close

public void close()

Description copied from class: AbstractNativeReference

Frees the underlying C++ object

It is strong recommended that the developer calls this after they have finished using the object.

Note, that once an instance of AbstractNativeReference has been closed, calling any of its functions will lead to undefined behavior.

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractImmutableNativeReference