Module io.github.mmm.value.observable

Package io.github.mmm.value.observable.container.map

Class ChangeAwareMaps

java.lang.Object

io.github.mmm.value.observable.container.map.ChangeAwareMaps

public final class ChangeAwareMaps
extends Object

Factory for ChangeAwareMap.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
static <K, V> ChangeAwareMap<K,V>	empty()
static <K, V> ChangeAwareMap<K,V>	of()
static <K, V> ChangeAwareMap<K,V>	of(int capacity)
static <K, V> ChangeAwareMap<K,V>	of(Map<K,V> map)
static <K, V> ChangeAwareMap<K,V>	ofUnmodifiable(Supplier<Map<K,V>> mapSupplier)
static <K, V> ChangeAwareMap<K,V>	ofUnmodifiable(Map<K,V> map)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

empty

public static <K,
V> ChangeAwareMap<K,V> empty()

Type Parameters:

K - type of the keys.

V - type of the values.

Returns:

an empty, immutable ChangeAwareMap.

of

public static <K,
V> ChangeAwareMap<K,V> of()

Type Parameters:

K - type of the keys.

V - type of the values.

Returns:

a new empty mutable ChangeAwareMap.

of

public static <K,
V> ChangeAwareMap<K,V> of(int capacity)

Type Parameters:

K - type of the keys.

V - type of the values.

Parameters:

capacity - the initial capacity of the map.

Returns:

a new empty mutable ChangeAwareMap.

of

public static <K,
V> ChangeAwareMap<K,V> of(Map<K,V> map)

Type Parameters:

K - type of the keys.

V - type of the values.

Parameters:

map - the existing Set implementation to wrap as ChangeAwareMap. Please avoid to modify this Map afterwards, as this will not trigger modification events.

Returns:

a new empty mutable ChangeAwareMap.

ofUnmodifiable

public static <K,
V> ChangeAwareMap<K,V> ofUnmodifiable(Map<K,V> map)

Type Parameters:

K - type of the keys.

V - type of the values.

Parameters:

map - the existing Map implementation to wrap as ChangeAwareMap. Modifying such Map afterwards will not trigger modification events in the read-only view returned by this method.

Returns:

a unmodifiable ChangeAwareMap that acts as a view on the given Map.

ofUnmodifiable

public static <K,
V> ChangeAwareMap<K,V> ofUnmodifiable(Supplier<Map<K,V>> mapSupplier)

Type Parameters:

K - type of the keys.

V - type of the values.

Parameters:

mapSupplier - the Supplier to the (mutable) Map implementation to wrap as ChangeAwareMap. Modifying such Map afterwards will not trigger modification events in the read-only view returned by this method.

Returns:

a unmodifiable ChangeAwareMap that acts as a view on the supplied Map.