com.electronwill.nightconfig.core.utils

Class TransformingMap<K,InternalV,ExternalV>

java.lang.Object

java.util.AbstractMap<K,ExternalV>

com.electronwill.nightconfig.core.utils.TransformingMap<K,InternalV,ExternalV>

All Implemented Interfaces:

java.util.Map<K,ExternalV>

public final class TransformingMap<K,InternalV,ExternalV>
extends java.util.AbstractMap<K,ExternalV>

A TransformingMap contains an internal Map<K, InternalV> values, and exposes the features of a Map<K, ExternalV> applying transformations to the values.

The transformations are applied "just in time", that is, the values are converted only when they are used, not during the construction of the TransformingMap.

For instance, if you have a Map<String, String> and you want to convert its values "just in time" to integers, you use a TransformingMap<String, String, Integer>. To get one, you create these three functions:

• one that converts a String to an Integer: that's the parse transformation. It converts an Integer read from the internal map to a String.
• one that converts an Integer to a String: that's the write transformation. It converts a String given to the TransformingMap to an Integer.
• one that converts an Object to another Object: that's the search transformation. It is used (mainly) by the containsKey(Object) method of the TransformingMap. If its argument is an Integer then it should convert it to an String in the same way as the write transformation. Otherwise, it is free to try to convert it to a String if possible, or not to.

Nested Class Summary

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TransformingMap(java.util.Map<K,InternalV> map, java.util.function.Function<? super InternalV,? extends ExternalV> readTransformation, java.util.function.Function<? super ExternalV,? extends InternalV> writeTransformation, java.util.function.Function<java.lang.Object,java.lang.Object> searchTransformation) Create a new TransformingMap.

Method Summary

Modifier and Type	Method and Description
void	clear()
ExternalV	compute(K key, java.util.function.BiFunction<? super K,? super ExternalV,? extends ExternalV> remappingFunction)
ExternalV	computeIfAbsent(K key, java.util.function.Function<? super K,? extends ExternalV> mappingFunction)
ExternalV	computeIfPresent(K key, java.util.function.BiFunction<? super K,? super ExternalV,? extends ExternalV> remappingFunction)
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,ExternalV>>	entrySet()
void	forEach(java.util.function.BiConsumer<? super K,? super ExternalV> action)
ExternalV	get(java.lang.Object key)
ExternalV	getOrDefault(java.lang.Object key, ExternalV defaultValue)
boolean	isEmpty()
java.util.Set<K>	keySet()
ExternalV	merge(K key, ExternalV value, java.util.function.BiFunction<? super ExternalV,? super ExternalV,? extends ExternalV> remappingFunction)
ExternalV	put(K key, ExternalV value)
void	putAll(java.util.Map<? extends K,? extends ExternalV> m)
ExternalV	putIfAbsent(K key, ExternalV value)
ExternalV	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
ExternalV	replace(K key, ExternalV value)
boolean	replace(K key, ExternalV oldValue, ExternalV newValue)
void	replaceAll(java.util.function.BiFunction<? super K,? super ExternalV,? extends ExternalV> function)
int	size()
java.util.Collection<ExternalV>	values()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformingMap

public TransformingMap(java.util.Map<K,InternalV> map,
                       java.util.function.Function<? super InternalV,? extends ExternalV> readTransformation,
                       java.util.function.Function<? super ExternalV,? extends InternalV> writeTransformation,
                       java.util.function.Function<java.lang.Object,java.lang.Object> searchTransformation)

Create a new TransformingMap.

Parameters:

map - the internal map to use

readTransformation - the parse transformation (see javadoc of the class)

writeTransformation - the write transformation (see javadoc of the class)

searchTransformation - the search transformation (see javadoc of the class)

Method Detail

size

public int size()

Specified by:

size in interface java.util.Map<K,ExternalV>

Overrides:

size in class java.util.AbstractMap<K,ExternalV>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K,ExternalV>

Overrides:

isEmpty in class java.util.AbstractMap<K,ExternalV>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<K,ExternalV>

Overrides:

containsKey in class java.util.AbstractMap<K,ExternalV>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K,ExternalV>

Overrides:

containsValue in class java.util.AbstractMap<K,ExternalV>

get

public ExternalV get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K,ExternalV>

Overrides:

get in class java.util.AbstractMap<K,ExternalV>

put

public ExternalV put(K key,
                     ExternalV value)

Specified by:

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

Overrides:

put in class java.util.AbstractMap<K,ExternalV>

remove

public ExternalV remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,ExternalV>

Overrides:

remove in class java.util.AbstractMap<K,ExternalV>

putAll

public void putAll(java.util.Map<? extends K,? extends ExternalV> m)

Specified by:

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

Overrides:

putAll in class java.util.AbstractMap<K,ExternalV>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<K,ExternalV>

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K,ExternalV>

Overrides:

keySet in class java.util.AbstractMap<K,ExternalV>

values

public java.util.Collection<ExternalV> values()

Specified by:

values in interface java.util.Map<K,ExternalV>

Overrides:

values in class java.util.AbstractMap<K,ExternalV>

entrySet

public java.util.Set<java.util.Map.Entry<K,ExternalV>> entrySet()

Specified by:

entrySet in interface java.util.Map<K,ExternalV>

Specified by:

entrySet in class java.util.AbstractMap<K,ExternalV>

getOrDefault

public ExternalV getOrDefault(java.lang.Object key,
                              ExternalV defaultValue)

forEach

public void forEach(java.util.function.BiConsumer<? super K,? super ExternalV> action)

replaceAll

public void replaceAll(java.util.function.BiFunction<? super K,? super ExternalV,? extends ExternalV> function)

putIfAbsent

public ExternalV putIfAbsent(K key,
                             ExternalV value)

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

replace

public boolean replace(K key,
                       ExternalV oldValue,
                       ExternalV newValue)

replace

public ExternalV replace(K key,
                         ExternalV value)

computeIfAbsent

public ExternalV computeIfAbsent(K key,
                                 java.util.function.Function<? super K,? extends ExternalV> mappingFunction)

computeIfPresent

public ExternalV computeIfPresent(K key,
                                  java.util.function.BiFunction<? super K,? super ExternalV,? extends ExternalV> remappingFunction)

compute

public ExternalV compute(K key,
                         java.util.function.BiFunction<? super K,? super ExternalV,? extends ExternalV> remappingFunction)

merge

public ExternalV merge(K key,
                       ExternalV value,
                       java.util.function.BiFunction<? super ExternalV,? super ExternalV,? extends ExternalV> remappingFunction)