com.hazelcast.ringbuffer.impl

Class ReadResultSetImpl<O,E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.hazelcast.ringbuffer.impl.ReadResultSetImpl<O,E>

Type Parameters:

O - deserialized ringbuffer type

E - result set type, is equal to O if the projection is null or returns the same type as the parameter

All Implemented Interfaces:

HazelcastInstanceAware, DataSerializable, IdentifiedDataSerializable, Versioned, ReadResultSet<E>, Iterable<E>, Collection<E>, List<E>

Direct Known Subclasses:

CacheEventJournalReadResultSetImpl, MapEventJournalReadResultSetImpl

public class ReadResultSetImpl<O,E>
extends AbstractList<E>
implements IdentifiedDataSerializable, HazelcastInstanceAware, ReadResultSet<E>, Versioned

A list for the ReadManyOperation.

The problem with a regular list is that if you store Data objects, then on the receiving side you get a list with data objects. If you hand this list out to the caller, you have a problem because he sees data objects instead of deserialized objects.

The predicate, filter and projection may be null in which case all elements are returned and no projection is applied.

Field Summary

Fields

Modifier and Type	Field and Description
protected SerializationService	serializationService

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ReadResultSetImpl()
ReadResultSetImpl(int minSize, int maxSize, SerializationService serializationService, IFunction<O,Boolean> filter)
ReadResultSetImpl(int minSize, int maxSize, SerializationService serializationService, Predicate<? super O> predicate, Projection<? super O,E> projection)

Method Summary

Modifier and Type	Method and Description
boolean	add(Object o)
void	addItem(long seq, Object item) Applies the Projection and adds an item to this ReadResultSetImpl if it passes the Predicate and IFunction with which it was constructed.
E	get(int index) Gets the item at the given index.
Data[]	getDataItems()
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
long	getSequence(int index) Return the sequence number for the item at the given index.
boolean	isMaxSizeReached()
boolean	isMinSizeReached()
int	readCount() Returns the number of items that have been read before filtering.
void	readData(ObjectDataInput in) Reads fields from the input stream
void	setHazelcastInstance(HazelcastInstance hz) Gets the HazelcastInstance reference when submitting a Runnable/Callable using Hazelcast ExecutorService.
void	setSerializationService(SerializationService serializationService)
int	size() Return the result set size.
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Field Detail

serializationService

protected transient SerializationService serializationService

Constructor Detail

ReadResultSetImpl

public ReadResultSetImpl()

ReadResultSetImpl

public ReadResultSetImpl(int minSize,
                         int maxSize,
                         SerializationService serializationService,
                         IFunction<O,Boolean> filter)

ReadResultSetImpl

public ReadResultSetImpl(int minSize,
                         int maxSize,
                         SerializationService serializationService,
                         Predicate<? super O> predicate,
                         Projection<? super O,E> projection)

Method Detail

isMaxSizeReached

public boolean isMaxSizeReached()

isMinSizeReached

public boolean isMinSizeReached()

getDataItems

public Data[] getDataItems()

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 the same as 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.

Specified by:

readCount in interface ReadResultSet<E>

Returns:

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

setHazelcastInstance

public void setHazelcastInstance(HazelcastInstance hz)

Description copied from interface: HazelcastInstanceAware

Gets the HazelcastInstance reference when submitting a Runnable/Callable using Hazelcast ExecutorService.

Specified by:

setHazelcastInstance in interface HazelcastInstanceAware

Parameters:

hz - the HazelcastInstance reference

setSerializationService

public void setSerializationService(SerializationService serializationService)

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>

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<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. 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.

Specified by:

getSequence in interface ReadResultSet<E>

Parameters:

index - the index

Returns:

the sequence number for the ringbuffer item

See Also:

Cluster.getClusterVersion()

addItem

public void addItem(long seq,
                    Object item)

Applies the Projection and adds an item to this ReadResultSetImpl if it passes the Predicate and IFunction with which it was constructed. The item may be in serialized or deserialized format as this method will adapt the parameter if necessary before providing it to the predicate and projection.

If the item is in Data format and there is no filter, predicate or projection, the item is added to the set without any additional serialization or deserialization.

Parameters:

seq - the sequence ID of the item

item - the item to add to the result set

add

public boolean add(Object o)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

size

public int size()

Description copied from interface: ReadResultSet

Return the result set size.

Specified by:

size in interface ReadResultSet<E>

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

Returns:

the result set size

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException