net.markenwerk.commons.collections.sinks

Class AbstractCollectionSink<Payload>

java.lang.Object

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

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Sink<Payload>

Direct Known Subclasses:

CollectionSink

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

An AbstractCollectionSink is an AbstractSink that is backed by a Collection.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractCollectionSink(Nullity nullity, Collection<Payload> collection) Creates a new AbstractCollectionSink.

Method Summary

Modifier and Type	Method and Description
protected void	doAdd(Payload payload) Adds the given payload value to this Sink.
Collection<Payload>	getCollection() Returns the Collection of payload values this AbstractCollectionSink 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

AbstractCollectionSink

public AbstractCollectionSink(Nullity nullity,
                              Collection<Payload> collection)
                       throws IllegalArgumentException

Creates a new AbstractCollectionSink.

Parameters:

nullity - The Nullity to be used.

collection - The Collection to be used.

Throws:

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

Method Detail

getCollection

public final Collection<Payload> getCollection()

Returns the Collection of payload values this AbstractCollectionSink has been created with.

Returns:

The Collection 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.