net.markenwerk.commons.collections.sources

Class CollectionSource<Payload>

java.lang.Object

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

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

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

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

A CollectionSource is an AbstractSource that is backed by a Collection of payload values.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
CollectionSource(Collection<Payload> collection) Creates a new CollectionSource.

Method Summary

Modifier and Type	Method and Description
Collection<Payload>	getCollection() Returns the Collection of payload values this CollectionSource has been created with.
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, doGetFirst, 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

CollectionSource

public CollectionSource(Collection<Payload> collection)
                 throws IllegalArgumentException

Creates a new CollectionSource.

Parameters:

collection - The collection of payload values to be used.

Throws:

IllegalArgumentException - If the given collection of payload values is null.

Method Detail

getCollection

public Collection<Payload> getCollection()

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

Returns:

The Collection of payload values.

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.

iterator

public ProtectedIterator<Payload> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Returns:

A ProtectedIterator.