com.hazelcast.ringbuffer

Interface ReadResultSet<E>

Type Parameters:

E - item type

All Superinterfaces:

Iterable<E>

All Known Implementing Classes:

CacheEventJournalReadResultSetImpl, MapEventJournalReadResultSetImpl, PortableReadResultSet, ReadResultSetImpl

public interface ReadResultSet<E>
extends Iterable<E>

The result of a Ringbuffer.readManyAsync(long, int, int, com.hazelcast.core.IFunction) operation.

Important:
If an item is retrieved multiple times from the result set, a new instance is returned for every invocation. This is done to prevent unexpected sharing if the ICompletableFuture is shared between multiple threads.

Method Summary

Modifier and Type	Method and Description
E	get(int index) Gets the item at the given index.
long	getSequence(int index) Return the sequence number for the item at the given index.
int	readCount() Returns the number of items that have been read before filtering.
int	size() Return the result set size.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

readCount

int readCount()

Returns the number of items that have been read before filtering.

If no filter is set, then the readCount will be equal to size(). But if a filter is applied, it could be that items are read, but are filtered out. So if you are trying to make another read based on the ReadResultSet then you should increment the sequence by readCount and not by size. Otherwise you will be re-reading the same filtered messages.

Returns:

the number of items read (including the filtered ones).

get

E get(int index)

Gets the item at the given index.

Parameters:

index - the index

Returns:

the found item.

Throws:

IllegalArgumentException - if index out of bounds.

getSequence

long getSequence(int index)

Return the sequence number for the item at the given index. The method may throw a UnsupportedOperationException if there are no sequences available. This can happen when the cluster version is Versions.V3_8 or lower.

Parameters:

index - the index

Returns:

the sequence number for the ringbuffer item

Throws:

IllegalArgumentException - if index out of bounds.

UnsupportedOperationException - if the sequence IDs are not available

Since:

3.9

See Also:

Cluster.getClusterVersion()

size

int size()

Return the result set size. See also readCount().

Returns:

the result set size

Since:

3.9