org.axonframework.axonserver.connector.query

Class QueueBackedSpliterator<R>

java.lang.Object

org.axonframework.axonserver.connector.query.QueueBackedSpliterator<R>

Type Parameters:

R - a generic defining the type this queue will contain

All Implemented Interfaces:

Spliterator<R>

public class QueueBackedSpliterator<R>
extends Object
implements Spliterator<R>

Converts the push interface for QueryResponses from Axon Server to a pull interface to be used by Axon Framework. Uses a queue to cache messages.

Since:

4.0

Author:

Marc Gathier

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor and Description
QueueBackedSpliterator(long timeout, TimeUnit timeUnit) Instantiate a queue backed Spliterator implementation.

Method Summary

Modifier and Type	Method and Description
void	cancel(Throwable t) Cancel further element retrieval of this queue.
int	characteristics()
long	estimateSize()
void	put(R object) Add an element to the queue.
boolean	tryAdvance(Consumer<? super R> action)
Spliterator<R>	trySplit()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Constructor Detail

QueueBackedSpliterator

public QueueBackedSpliterator(long timeout,
                              TimeUnit timeUnit)

Instantiate a queue backed Spliterator implementation. The given timeout combined with the timeUnit define for how long the tryAdvance(Consumer) method can be invoked. After the timeout has exceeded, tryAdvance(Consumer) defaults to false.

Parameters:

timeout - a long defining the timeout, together with the provided timeUnit

timeUnit - a TimeUnit defining the unit of time for the provided timeout

Method Detail

tryAdvance

public boolean tryAdvance(Consumer<? super R> action)

Specified by:

tryAdvance in interface Spliterator<R>

trySplit

public Spliterator<R> trySplit()

Specified by:

trySplit in interface Spliterator<R>

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface Spliterator<R>

characteristics

public int characteristics()

Specified by:

characteristics in interface Spliterator<R>

put

public void put(R object)

Add an element to the queue.

Parameters:

object - an R to be added to the queue

cancel

public void cancel(Throwable t)

Cancel further element retrieval of this queue.

Parameters:

t - a Throwable marking why the queue was canceled. Can be null