net.markenwerk.commons.collections.sources

Class MapValueSource<Value>

java.lang.Object

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

net.markenwerk.commons.collections.sources.MapValueSource<Value>

Type Parameters:

Value - The map value type.

All Implemented Interfaces:

Iterable<Value>, Source<Value>, ProtectedIterable<Value>

public final class MapValueSource<Value>
extends AbstractSource<Value>

A MapValueSource is an AbstractSource that is backed by the values of a Map.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
MapValueSource(Map<?,? extends Value> map) Creates a new MapValueSource.

Method Summary

Modifier and Type	Method and Description
Map<?,? extends Value>	getMap() Returns the Map of payload values this MapKeySource has been created with.
ProtectedIterator<Value>	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

MapValueSource

public MapValueSource(Map<?,? extends Value> map)
               throws IllegalArgumentException

Creates a new MapValueSource.

Parameters:

map - The Map of payload values to be used.

Throws:

IllegalArgumentException - If the given Map of payload values to be used is null.

Method Detail

getMap

public Map<?,? extends Value> getMap()

Returns the Map of payload values this MapKeySource has been created with.

Returns:

The Map 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<Value> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Returns:

A ProtectedIterator.