net.markenwerk.commons.collections.sinks

Interface Sink<Payload>

Type Parameters:

Payload - The payload type

All Known Implementing Classes:

AbstractCollectionSink, AbstractHandlerSink, AbstractSequenceSink, AbstractSink, AbstractStackSink, CollectionSink, HandlerSink, SequenceSink, StackSink

public interface Sink<Payload>

A Sink is write-only data structure.

A Sink is intended to be used in API interfaces where the publishing component wants to expose write-only access.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

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.
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.
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.
String	toString() The String [].

Method Detail

add

Sink<Payload> add(Payload payload)
           throws IllegalArgumentException

Adds the given payload value.

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.

addAll

Sink<Payload> addAll(Payload... payloads)
              throws IllegalArgumentException

Adds the given payload values.

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.

addAll

Sink<Payload> addAll(Iterable<? extends Payload> payloads)
              throws IllegalArgumentException

Adds the given payload values.

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.

hashCode

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.

Overrides:

hashCode in class Object

Returns:

The hash code of this Sink.

equals

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.

Overrides:

equals in class Object

toString

String toString()

The String [].

Overrides:

toString in class Object

Returns:

The String [].