net.markenwerk.commons.collections.sinks

Class AbstractSequenceSink<Payload>

java.lang.Object

net.markenwerk.commons.collections.sinks.AbstractSink<Payload>

net.markenwerk.commons.collections.sinks.AbstractSequenceSink<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Sink<Payload>

Direct Known Subclasses:

SequenceSink

public abstract class AbstractSequenceSink<Payload>
extends AbstractSink<Payload>

An AbstractSequenceSink is an AbstractSink that is backed by a Sequence.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractSequenceSink(Nullity nullity, Sequence<Payload> sequence) Creates a new AbstractSequenceSink.

Method Summary

Modifier and Type	Method and Description
protected void	doAdd(Payload payload) Adds the given payload value to this Sink.
Sequence<Payload>	getSequence() Returns the Sequence of payload values this AbstractSequenceSink has been created with.

Methods inherited from class net.markenwerk.commons.collections.sinks.AbstractSink

add, addAll, addAll, equals, getNullity, hashCode, onAdded, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSequenceSink

public AbstractSequenceSink(Nullity nullity,
                            Sequence<Payload> sequence)
                     throws IllegalArgumentException

Creates a new AbstractSequenceSink.

Parameters:

nullity - The Nullity to be used.

sequence - The Sequence to be used.

Throws:

IllegalArgumentException - If the given Nullity is null or if the given Sequence is null.

Method Detail

getSequence

public final Sequence<Payload> getSequence()

Returns the Sequence of payload values this AbstractSequenceSink has been created with.

Returns:

The Sequence of payload values.

doAdd

protected final void doAdd(Payload payload)

Description copied from class: AbstractSink

Adds the given payload value to this Sink.

Specified by:

doAdd in class AbstractSink<Payload>

Parameters:

payload - The payload to be added, which is guaranteed to be not null, unless the Nullity of this Sink is Nullity.ALLOW.