com.hazelcast.ringbuffer.impl.client

Class PortableReadResultSet<E>

java.lang.Object

com.hazelcast.ringbuffer.impl.client.PortableReadResultSet<E>

All Implemented Interfaces:

Portable, ReadResultSet<E>, Iterable<E>

public class PortableReadResultSet<E>
extends Object
implements Portable, ReadResultSet<E>

Field Summary

Fields inherited from interface com.hazelcast.ringbuffer.ReadResultSet

SEQUENCE_UNAVAILABLE

Constructor Summary

Constructors

Constructor and Description
PortableReadResultSet()
PortableReadResultSet(int readCount, List<Data> items, long[] seqs, long nextSeq)

Method Summary

Modifier and Type	Method and Description
E	get(int index) Gets the item at the given index.
int	getClassId() Returns class identifier for this portable class.
List<Data>	getDataItems()
int	getFactoryId() Returns PortableFactory ID for this portable class
long	getNextSequenceToReadFrom() Returns the sequence of the item following the last read item.
long	getSequence(int index) Return the sequence number for the item at the given index.
Iterator<E>	iterator()
int	readCount() Returns the number of items that have been read before filtering.
void	readPortable(PortableReader reader) Read portable fields using PortableReader
void	setSerializationService(SerializationService serializationService)
int	size() Return the result set size.
void	writePortable(PortableWriter writer) Serialize this portable object using PortableWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PortableReadResultSet

public PortableReadResultSet()

PortableReadResultSet

public PortableReadResultSet(int readCount,
                             List<Data> items,
                             long[] seqs,
                             long nextSeq)

Method Detail

getDataItems

public List<Data> getDataItems()

setSerializationService

public void setSerializationService(SerializationService serializationService)

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

readCount

public int readCount()

Description copied from interface: ReadResultSet

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

If no filter is set, then the readCount will be equal to ReadResultSet.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 ReadResultSet.size(). Otherwise you will be re-reading the same filtered messages.

Specified by:

readCount in interface ReadResultSet<E>

Returns:

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

get

public E get(int index)

Description copied from interface: ReadResultSet

Gets the item at the given index.

Specified by:

get in interface ReadResultSet<E>

Parameters:

index - the index

Returns:

the found item.

getSequence

public long getSequence(int index)

Description copied from interface: ReadResultSet

Return the sequence number for the item at the given index.

Specified by:

getSequence in interface ReadResultSet<E>

Parameters:

index - the index

Returns:

the sequence number for the ringbuffer item

See Also:

Cluster.getClusterVersion()

size

public int size()

Description copied from interface: ReadResultSet

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

Specified by:

size in interface ReadResultSet<E>

Returns:

the result set size

getNextSequenceToReadFrom

public long getNextSequenceToReadFrom()

Description copied from interface: ReadResultSet

Returns the sequence of the item following the last read item. This sequence can then be used to read items following the ones returned by this result set. Usually this sequence is equal to the sequence used to retrieve this result set incremented by the ReadResultSet.readCount(). In cases when the reader tolerates lost items, this is not the case. For instance, if the reader requests an item with a stale sequence (one which has already been overwritten), the read will jump to the oldest sequence and read from there. Similarly, if the reader requests an item in the future (e.g. because the partition was lost and the reader was unaware of this), the read method will jump back to the newest available sequence. Because of these jumps and only in the case when the reader is loss tolerant, the next sequence must be retrieved using this method. A return value of -1 means that the information is not available.

Specified by:

getNextSequenceToReadFrom in interface ReadResultSet<E>

Returns:

the sequence of the item following the last item in the result set

getFactoryId

public int getFactoryId()

Description copied from interface: Portable

Returns PortableFactory ID for this portable class

Specified by:

getFactoryId in interface Portable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: Portable

Returns class identifier for this portable class. Class ID should be unique per PortableFactory.

Specified by:

getClassId in interface Portable

Returns:

class ID

writePortable

public void writePortable(PortableWriter writer)
                   throws IOException

Description copied from interface: Portable

Serialize this portable object using PortableWriter

Specified by:

writePortable in interface Portable

Parameters:

writer - PortableWriter

Throws:

IOException

readPortable

public void readPortable(PortableReader reader)
                  throws IOException

Description copied from interface: Portable

Read portable fields using PortableReader

Specified by:

readPortable in interface Portable

Parameters:

reader - PortableReader

Throws:

IOException