net.markenwerk.commons.collections.sources

Class OptionalSource<Payload>

java.lang.Object

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

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

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

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

A OptionalSource is an AbstractSource that is backed by an Optional.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
OptionalSource(Optional<Payload> optional) Creates a new OptionalSource.

Method Summary

Modifier and Type	Method and Description
protected Payload	doGetFirst() Returns the first (i.e.
Optional<Payload>	getOptional() Returns the Optional this OptionalSource has been created with.
ProtectedBidirectionalIterator<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

OptionalSource

public OptionalSource(Optional<Payload> optional)
               throws IllegalArgumentException

Creates a new OptionalSource.

Parameters:

optional - The Optional to be used.

Throws:

IllegalArgumentException - If the given optional is null.

Method Detail

getOptional

public Optional<Payload> getOptional()

Returns the Optional this OptionalSource has been created with.

Returns:

The payload Object.

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 ProtectedBidirectionalIterator<Payload> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Returns:

A ProtectedIterator.