net.markenwerk.commons.collections.sources

Class ListSource<Payload>

java.lang.Object

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

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

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

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, IndexedSource<Payload>, Source<Payload>, BidirectionalIterable<Payload>, ProtectedBidirectionalIterable<Payload>, ProtectedIterable<Payload>

public final class ListSource<Payload>
extends AbstractIndexedSource<Payload>

An ListSource is an AbstractIndexedSource that is backed by a List.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
ListSource(List<Payload> list) Creates a new CodeSource.

Method Summary

Modifier and Type	Method and Description
protected Payload	doGet(int index) Returns a payload value at the given index.
protected ProtectedBidirectionalIterator<Payload>	doIterator(boolean reverse) Returns a ProtectedBidirectionalIterator.
List<Payload>	getList() Returns the List of payload values this ListSource has been created with.
int	size() Returns the number of payload values of this Source.

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

doGetFirst, firstIndexOf, firstIndexOfMatch, get, getLast, getLast, getLastMatch, isFirst, isLast, iterator, iterator, lastIndexOf, lastIndexOfMatch

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 net.markenwerk.commons.collections.sources.IndexedSource

getFirst, getFirst, getFirstMatch

Methods inherited from interface net.markenwerk.commons.collections.sources.Source

contains, containsAll, containsAll, containsMatch, getAll, getAllMatches, isEmpty

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ListSource

public ListSource(List<Payload> list)
           throws IllegalArgumentException

Creates a new CodeSource.

Parameters:

list - The List of payload values to be used.

Throws:

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

Method Detail

getList

public final List<Payload> getList()

Returns the List of payload values this ListSource has been created with.

Returns:

The List 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.

doGet

protected Payload doGet(int index)

Description copied from class: AbstractIndexedSource

Returns a payload value at the given index.

Specified by:

doGet in class AbstractIndexedSource<Payload>

Parameters:

index - The index to be used, which is guaranteed to be not negative and not larger then or equal to the size of this AbstractIndexedSource.

Returns:

The payload value.

doIterator

protected ProtectedBidirectionalIterator<Payload> doIterator(boolean reverse)

Description copied from class: AbstractIndexedSource

Returns a ProtectedBidirectionalIterator.

Specified by:

doIterator in class AbstractIndexedSource<Payload>

Parameters:

reverse - The initial index to be used. Whether to return a ProtectedBidirectionalIterator that iterates this indexed source in reverse.

Returns:

A ProtectedBidirectionalIterator.