Package org.simpleframework.util
Class KeyMap<T>
The
KeyMap
object is used to represent a map of values
keyed using a known string. This also ensures that the keys and
the values added to this hash map can be acquired in an independent
list of values, ensuring that modifications to the map do not have
an impact on the lists provided, and vice versa. The key map can
also be used in a fore each look using the string keys.- Author:
- Niall Gallagher
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,
V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object, V extends Object> -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
KeyMap
public KeyMap()Constructor for theKeyMap
object. This creates a hash map that can expose the keys and values of the map as an independentList
containing the values. This can also be used within a for loop for convenience.
-
-
Method Details
-
iterator
This is used to produce anIterator
of values that can be used to acquire the contents of the key map within a for each loop. The key map can be modified while it is been iterated as the iterator is an independent list of values. -
getKeys
This is used to produce aList
of the keys in the map. The list produced is a copy of the internal keys and so can be modified and used without affecting this map object.- Returns:
- this returns an independent list of the key values
-
getValues
This is used to produce aList
of the values in the map. The list produced is a copy of the internal values and so can be modified and used without affecting this map object.- Returns:
- this returns an independent list of the values
-