Package org.jvnet.basicjaxb.lang

Class ListBackedMap<T,K,V>

java.lang.Object

java.util.AbstractMap<K,V>

org.jvnet.basicjaxb.lang.ListBackedMap<T,K,V>

Type Parameters:

T - The type of elements in the backing list.

K - The type of keys maintained by this map.

V - The type of mapped values.

Reference: how-to-generate-a-map-backed-by-a-list

All Implemented Interfaces:

Map<K,V>

public class ListBackedMap<T,K,V>
extends AbstractMap<K,V>

A Map "view" backed by a List of key value objects where changes to the map are reflected in the underlying list.

Example:

 class CustomField 
 {
     String key;
     String value;
 }

 List<CustomField> list = getList();
 ListBackedMap<CustomField, String, String> map =
     new ListBackedMap<>
     (
         list,
         (key, value) -> new CustomField(key, value),
         CustomField::getKey,
         CustomField::getValue
     );
 

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
ListBackedMap(List<T> list, BiFunction<K,V,T> keyValueToElement, Function<T,K> elementToKey, Function<T,V> elementToValue)	Construct with a backing List

Method Summary

Modifier and Type	Method	Description
Set<Map.Entry<K,V>>	entrySet()	Collect a Set of map Map.Entry from the backing List.
List<T>	getList()	Get the backing List.
V	put(K key, V value)	Put a key-value pair into the backing List.

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

ListBackedMap

public ListBackedMap(List<T> list,
 BiFunction<K,V,T> keyValueToElement,
 Function<T,K> elementToKey,
 Function<T,V> elementToValue)

Construct with a backing List

Parameters:

list - The backing List instance.

keyValueToElement - The BiFunction to provide the list elements.

elementToKey - The Function to provide the map's key.

elementToValue - The Function to provide the map's value.

Method Details

entrySet

public Set<Map.Entry<K,V>> entrySet()

Collect a Set of map Map.Entry from the backing List.

Specified by:

entrySet in interface Map<T,K>

Specified by:

entrySet in class AbstractMap<K,V>

put

public V put(K key,
 V value)

Put a key-value pair into the backing List. Any matching previous key-value pair is replaced.

Specified by:

put in interface Map<T,K>

Overrides:

put in class AbstractMap<K,V>

getList

public List<T> getList()

Get the backing List.

Returns:

The backing List for the Map.