Package org.apache.openjpa.lib.util.collections

Interface IterableMap<K,V>

Type Parameters:

K - the type of the keys in this map

V - the type of the values in this map

All Superinterfaces:

java.util.Map<K,V>

All Known Subinterfaces:

BidiMap<K,V>, BoundedMap<K,V>, IterableSortedMap<K,V>, OrderedBidiMap<K,V>, OrderedMap<K,V>, SortedBidiMap<K,V>

All Known Implementing Classes:

AbstractDualBidiMap, AbstractHashedMap, AbstractIterableMap, AbstractLinkedMap, AbstractMapDecorator, AbstractOrderedMapDecorator, AbstractReferenceMap, AbstractSortedMapDecorator, DualHashBidiMap, DualTreeBidiMap, DualTreeBidiMap.ViewMap, LinkedMap, LRUMap, LRUMap, ReferenceHashMap, ReferenceIdentityMap, ReferenceMap, TreeBidiMap, UnmodifiableOrderedMap

public interface IterableMap<K,V>
extends java.util.Map<K,V>

Defines a map that can be iterated directly without needing to create an entry set.

A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or use Map Entry objects.

 IterableMap<String,Integer> map = new HashedMap<String,Integer>();
 MapIterator<String,Integer> it = map.mapIterator();
 while (it.hasNext()) {
   String key = it.next();
   Integer value = it.getValue();
   it.setValue(value + 1);
 }
 

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
void	clear()
MapIterator<K,V>	mapIterator()	Obtains a MapIterator over the map.
V	put(K key, V value)	Note that the return type is Object, rather than V as in the Map interface.
void	putAll(java.util.Map<? extends K,? extends V> t)

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

clear

void clear()

Specified by:

clear in interface java.util.Map<K,V>

See Also:

Map.clear()

put

V put(K key,
      V value)

Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.

Specified by:

put in interface java.util.Map<K,V>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

See Also:

Map.put(Object, Object)

putAll

void putAll(java.util.Map<? extends K,? extends V> t)

Specified by:

putAll in interface java.util.Map<K,V>

Parameters:

t - mappings to be stored in this map

See Also:

Map.putAll(Map)

mapIterator

MapIterator<K,V> mapIterator()

Obtains a MapIterator over the map.

A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or use Map Entry objects.

 IterableMap<String,Integer> map = new HashedMap<String,Integer>();
 MapIterator<String,Integer> it = map.mapIterator();
 while (it.hasNext()) {
   String key = it.next();
   Integer value = it.getValue();
   it.setValue(value + 1);
 }
 

Returns:

a map iterator