net.morimekta.providence.streams

Class MessageSpliterator<Message extends PMessage<Message>>

java.lang.Object

net.morimekta.providence.streams.MessageSpliterator<Message>

All Implemented Interfaces:

Spliterator<Message>

public class MessageSpliterator<Message extends PMessage<Message>>
extends Object
implements Spliterator<Message>

Spliterator that reads messages from a stream.

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
MessageSpliterator(InputStream in, Serializer serializer, PMessageDescriptor<Message> descriptor) Make a self-closing message spliterator.
MessageSpliterator(InputStream in, Serializer serializer, PMessageDescriptor<Message> descriptor, Closeable closer) Make a spliterator with specific closing function.

Method Summary

Modifier and Type	Method and Description
int	characteristics() Ordered, non-null and immutable.
long	estimateSize() We mostly never know the number of messages in a message stream until the last message has been read.
Comparator<? super Message>	getComparator() Messages are comparable.
long	getExactSizeIfKnown() We mostly never know the number of messages in a message stream until the last message has been read.
boolean	tryAdvance(Consumer<? super Message> action)
Spliterator<Message>	trySplit() Normally we cannot split the stream.

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, hasCharacteristics

Constructor Detail

MessageSpliterator

public MessageSpliterator(@Nonnull
                          InputStream in,
                          @Nonnull
                          Serializer serializer,
                          @Nonnull
                          PMessageDescriptor<Message> descriptor)

Make a self-closing message spliterator.

Parameters:

in - Input stream to read from.

serializer - Serializer to use.

descriptor - The message descriptor of contained messages.

MessageSpliterator

public MessageSpliterator(@Nonnull
                          InputStream in,
                          @Nonnull
                          Serializer serializer,
                          @Nonnull
                          PMessageDescriptor<Message> descriptor,
                          @Nullable
                          Closeable closer)

Make a spliterator with specific closing function.

Parameters:

in - Input stream to read from.

serializer - Serializer to use.

descriptor - The message descriptor of contained messages.

closer - The stream closer function. If null nothing is done when closing the spliterator.

Method Detail

tryAdvance

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

Specified by:

tryAdvance in interface Spliterator<Message extends PMessage<Message>>

trySplit

public Spliterator<Message> trySplit()

Normally we cannot split the stream.

Specified by:

trySplit in interface Spliterator<Message extends PMessage<Message>>

Returns:

null (no split).

estimateSize

public long estimateSize()

We mostly never know the number of messages in a message stream until the last message has been read.

Specified by:

estimateSize in interface Spliterator<Message extends PMessage<Message>>

Returns:

Long.MAX_VALUE (not known).

getExactSizeIfKnown

public long getExactSizeIfKnown()

We mostly never know the number of messages in a message stream until the last message has been read.

Specified by:

getExactSizeIfKnown in interface Spliterator<Message extends PMessage<Message>>

Returns:

-1 (not known).

characteristics

public int characteristics()

Ordered, non-null and immutable.

Specified by:

characteristics in interface Spliterator<Message extends PMessage<Message>>

Returns:

The characteristics.

getComparator

public Comparator<? super Message> getComparator()

Messages are comparable.

Specified by:

getComparator in interface Spliterator<Message extends PMessage<Message>>

Returns:

Comparable compareTo method.