net.markenwerk.commons.collections.sources

Class ObjectSource<Payload>

java.lang.Object

net.markenwerk.commons.collections.sources.AbstractSource<Payload>

net.markenwerk.commons.collections.sources.ObjectSource<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, Source<Payload>, ProtectedIterable<Payload>

public final class ObjectSource<Payload>
extends AbstractSource<Payload>

A ObjectSource is an AbstractSource that is backed by a single payload value.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ObjectSource(Payload value) Creates a new ObjectSource for the given payload object.
ObjectSource(Payload value, boolean ignoreNull) Creates a new ObjectSource for the given payload object.

Method Summary

Modifier and Type	Method and Description
protected Payload	doGetFirst() Returns the first (i.e.
Payload	getValue() Returns the payload value this ObjectSource has been created with.
boolean	hasValue() Returns whether this ObjectSource has a value.
ProtectedIterator<Payload>	iterator() Returns a ProtectedIterator.
int	size() Returns the number of payload values of this Source.

Methods inherited from class net.markenwerk.commons.collections.sources.AbstractSource

contains, containsAll, containsAll, containsMatch, createPredicate, firstIndexOf, getAll, getAllMatches, getFirst, getFirst, getFirstMatch, isEmpty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ObjectSource

public ObjectSource(Payload value)

Creates a new ObjectSource for the given payload object.

Parameters:

value - The payload value to be used.

ObjectSource

public ObjectSource(Payload value,
                    boolean ignoreNull)

Creates a new ObjectSource for the given payload object.

Parameters:

value - The payload value to be used.

ignoreNull - Whether to ignore null values.

Method Detail

hasValue

public boolean hasValue()

Returns whether this ObjectSource has a value.

Returns:

Whether this ObjectSource has a value.

getValue

public Payload getValue()
                 throws NoSuchElementException

Returns the payload value this ObjectSource has been created with.

Returns:

The payload Object.

Throws:

NoSuchElementException - If this ObjectSource has no value.

size

public int size()

Description copied from interface: Source

Returns the number of payload values of this Source.

Returns:

The number of payload values of this Source.

doGetFirst

protected Payload doGetFirst()

Description copied from class: AbstractSource

Returns the first (i.e. first payload value in an iterator) payload value, which is guaranteed to exist.

Overrides:

doGetFirst in class AbstractSource<Payload>

Returns:

The payload value.

iterator

public ProtectedIterator<Payload> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Returns:

A ProtectedIterator.