org.tools4j.elara.log

Interface IndexTrackingPoller

All Superinterfaces:

MessageLog.Poller

All Known Implementing Classes:

DefaultIndexTrackingPoller

public interface IndexTrackingPoller
extends MessageLog.Poller

A poller tracking (gap free) indexes of entries in the message log. Note that all methods that are moving by more than a single index are slow!

Method Summary

Modifier and Type	Method and Description
static IndexTrackingPoller	create(MessageLog messageLog)
long	index() Returns the current index of this poller.
MessageLog.Poller	moveToEnd() NOTE: this method is possibly slow if it has to move a lot of positions! Moves to the end of the message log.
boolean	moveToIndex(long index) NOTE: this method is possibly slow if it has to move a lot of positions! Moves to the specified index

Methods inherited from interface org.tools4j.elara.log.MessageLog.Poller

entryId, moveTo, moveToNext, moveToPrevious, moveToStart, poll

Method Detail

index

long index()

Returns the current index of this poller.

It returns the index of the message currently polled if invoked while polling a message. Otherwise it returns the index of the next message to be polled.

The index monotonically increasing and gap free.

Returns:

the current index of this poller.

moveToIndex

boolean moveToIndex(long index)

NOTE: this method is possibly slow if it has to move a lot of positions! Moves to the specified index

Parameters:

index - the index to move to, valid from zero to (#entries - 1)

Returns:

true if such an index is found

moveToEnd

MessageLog.Poller moveToEnd()

NOTE: this method is possibly slow if it has to move a lot of positions! Moves to the end of the message log.

Specified by:

moveToEnd in interface MessageLog.Poller

Returns:

this poller

create

static IndexTrackingPoller create(MessageLog messageLog)