net.markenwerk.commons.collections.sources

Class MapKeySource<Key>

java.lang.Object

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

net.markenwerk.commons.collections.sources.MapKeySource<Key>

Type Parameters:

Key - The map key type.

All Implemented Interfaces:

Iterable<Key>, Source<Key>, ProtectedIterable<Key>

public final class MapKeySource<Key>
extends AbstractSource<Key>

A MapKeySource is an AbstractSource that is backed by the keys of a Map.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

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

MapKeySource

public MapKeySource(Map<? extends Key,?> map)
             throws IllegalArgumentException

Creates a new MapKeySource.

Parameters:

map - The Map of payload keys to be used.

Throws:

IllegalArgumentException - If the given Map of payload keys is null.

Method Detail

getMap

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

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

Returns:

The Map of payload keys.

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<Key> iterator()

Description copied from interface: ProtectedIterable

Returns a ProtectedIterator.

Returns:

A ProtectedIterator.