net.markenwerk.commons.collections.sinks

Class AbstractSink<Payload>

java.lang.Object

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Sink<Payload>

Direct Known Subclasses:

AbstractCollectionSink, AbstractHandlerSink, AbstractSequenceSink, AbstractStackSink

public abstract class AbstractSink<Payload>
extends Object
implements Sink<Payload>

An AbstractSink is an abstract base implementation of a Sink.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
AbstractSink(Nullity nullity) Creates a new AbstractSink.

Method Summary

Modifier and Type	Method and Description
Sink<Payload>	add(Payload payload) Adds the given payload value.
Sink<Payload>	addAll(Iterable<? extends Payload> payloads) Adds the given payload values.
Sink<Payload>	addAll(Payload... payloads) Adds the given payload values.
protected abstract void	doAdd(Payload payload) Adds the given payload value to this Sink.
boolean	equals(Object object) Compares the given object with this Sink for equality, which must not reveal any information about the payload values that have been added so far.
Nullity	getNullity() Returns the Nullity this AbstractSink has been created with.
int	hashCode() Returns the hash code of this Sink, which must not reveal any information about the payload values that have been added so far.
protected void	onAdded(Payload payload) Called after the given payload value has been added to this Sink.
String	toString() The String [].

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSink

public AbstractSink(Nullity nullity)
             throws IllegalArgumentException

Creates a new AbstractSink.

Parameters:

nullity - The intended Nullity of added null -values

Throws:

IllegalArgumentException - If the given Nullity is null.

Method Detail

getNullity

public final Nullity getNullity()

Returns the Nullity this AbstractSink has been created with.

Returns:

The Nullity.

add

public final Sink<Payload> add(Payload payload)
                        throws IllegalArgumentException,
                               IllegalStateException

Description copied from interface: Sink

Adds the given payload value.

Specified by:

add in interface Sink<Payload>

Parameters:

payload - The payload value to be added.

Returns:

This Sink.

Throws:

IllegalArgumentException - If the given payload value is null and this Sink doesn't allow a null to be added.

IllegalStateException

addAll

public final Sink<Payload> addAll(Payload... payloads)
                           throws IllegalArgumentException,
                                  IllegalStateException

Description copied from interface: Sink

Adds the given payload values.

Specified by:

addAll in interface Sink<Payload>

Parameters:

payloads - The array of payload values to be added.

Returns:

This Sink.

Throws:

IllegalArgumentException - If the given array of payload values is null or if any of the given payload values is null and this Sink doesn't allow a null to be added.

IllegalStateException

addAll

public final Sink<Payload> addAll(Iterable<? extends Payload> payloads)
                           throws IllegalArgumentException,
                                  IllegalStateException

Description copied from interface: Sink

Adds the given payload values.

Specified by:

addAll in interface Sink<Payload>

Parameters:

payloads - The Iterable of payload values to be added.

Returns:

This Sink.

Throws:

IllegalArgumentException - If the given Iterable of payload values is null or if any of the given payload values is null and this Sink doesn't allow a null to be added.

IllegalStateException

doAdd

protected abstract void doAdd(Payload payload)

Adds the given payload value to this Sink.

Parameters:

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

onAdded

protected void onAdded(Payload payload)

Called after the given payload value has been added to this Sink.

Parameters:

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

hashCode

public final int hashCode()

Description copied from interface: Sink

Returns the hash code of this Sink, which must not reveal any information about the payload values that have been added so far.

Specified by:

hashCode in interface Sink<Payload>

Overrides:

hashCode in class Object

Returns:

The hash code of this Sink.

equals

public final boolean equals(Object object)

Description copied from interface: Sink

Compares the given object with this Sink for equality, which must not reveal any information about the payload values that have been added so far.

Specified by:

equals in interface Sink<Payload>

Overrides:

equals in class Object

toString

public final String toString()

Description copied from interface: Sink

The String [].

Specified by:

toString in interface Sink<Payload>

Overrides:

toString in class Object

Returns:

The String [].