io.atomix.storage.journal

Interface JournalReader<E>

All Superinterfaces:

AutoCloseable, Iterator<Indexed<E>>

All Known Implementing Classes:

DelegatingJournalReader, JournalSegmentReader, SegmentedJournalReader

public interface JournalReader<E>
extends Iterator<Indexed<E>>, AutoCloseable

Log reader.

Author:

Method Summary

Modifier and Type	Method and Description
void	close()
Indexed<E>	getCurrentEntry() Returns the last read entry.
long	getCurrentIndex() Returns the current reader index.
long	getNextIndex() Returns the next reader index.
boolean	hasNext() Returns whether the reader has a next entry to read.
Indexed<E>	next() Returns the next entry in the reader.
void	reset() Resets the reader to the start.
void	reset(long index) Resets the reader to the given index.

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Method Detail

getCurrentIndex

long getCurrentIndex()

Returns the current reader index.

Returns:

The current reader index.

getCurrentEntry

Indexed<E> getCurrentEntry()

Returns the last read entry.

Returns:

The last read entry.

getNextIndex

long getNextIndex()

Returns the next reader index.

Returns:

The next reader index.

hasNext

boolean hasNext()

Returns whether the reader has a next entry to read.

Specified by:

hasNext in interface Iterator<Indexed<E>>

Returns:

Whether the reader has a next entry to read.

next

Indexed<E> next()

Returns the next entry in the reader.

Specified by:

next in interface Iterator<Indexed<E>>

Returns:

The next entry in the reader.

reset

void reset()

Resets the reader to the start.

reset

void reset(long index)

Resets the reader to the given index.

Parameters:

index - The index to which to reset the reader.

close

void close()

Specified by:

close in interface AutoCloseable