Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.internal

Class LazyMapImpl<K,V>

java.lang.Object

org.tquadrat.foundation.util.internal.LazyMapImpl<K,V>

Type Parameters:

K - The type of keys maintained by this map

V - The type of mapped values

All Implemented Interfaces:

Map<K,V>, LazyMap<K,V>

Direct Known Subclasses:

LazySortedMapImpl

@ClassVersion(sourceVersion="$Id: LazyMapImpl.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public sealed class LazyMapImpl<K,V>
extends Object
implements LazyMap<K,V>
permits LazySortedMapImpl<K,V>

The implementation for LazyMap.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: LazyMapImpl.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.internal.LazyMapImpl"

⁠

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private final Lazy<? extends Map<K,V>>	m_Holder	The holder for the real map.
private final boolean	m_SupplierPopulates	The flag that indicates whether the provided supplier will put values to the list on initialisation.

Constructor Summary

Constructors

Constructor	Description
LazyMapImpl(boolean doPopulate, Supplier<? extends Map<K,V>> supplier)	Creates a new LazyMapImpl instance.
LazyMapImpl(Map<K,V> value)	Creates a new LazyMapImpl instance that is initialised with the given value.

Method Summary

Modifier and Type	Method	Description
final void	clear()
final boolean	containsKey(Object key)
final boolean	containsValue(Object value)
final Set<Map.Entry<K,V>>	entrySet()
final boolean	equals(Object o)
final V	get(Object key)
final int	hashCode()
protected Lazy<? extends Map<K,V>>	holder()	Gives access to the internal Lazy instance for derived classes.
void	ifPresent(Consumer<? super Map<K,V>> consumer)	If this LazyMap instance has been initialised already, the provided Consumer will be executed; otherwise nothing happens.
final void	init()	Forces the initialisation of this LazyMap instance.
final boolean	isEmpty()
final boolean	isPresent()	Checks whether this LazyMap instance has been initialised already.
final Set<K>	keySet()
final V	put(K key, V value)
final void	putAll(Map<? extends K,? extends V> map)
final V	remove(Object key)
final int	size()
final String	toString()
final Collection<V>	values()

Methods inherited from class java.lang.Object

clone, 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

Field Details

m_Holder

private final Lazy<? extends Map<K,V>> m_Holder

The holder for the real map.

m_SupplierPopulates

private final boolean m_SupplierPopulates

The flag that indicates whether the provided supplier will put values to the list on initialisation.

Constructor Details

LazyMapImpl

public LazyMapImpl(boolean doPopulate,
 Supplier<? extends Map<K,V>> supplier)

Creates a new LazyMapImpl instance.

Parameters:

doPopulate - true if the provided supplier will put values to the map on initialisation, false if it will create an empty map.

supplier - The supplier that initialises the internal map for this instance when it is first needed.

LazyMapImpl

public LazyMapImpl(Map<K,V> value)

Creates a new LazyMapImpl instance that is initialised with the given value.

Parameters:

value - The initialisation value.

Method Details

clear

public final void clear()

Specified by:

clear in interface Map<K,V>

containsKey

public final boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public final boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

equals

public final boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

get

public final V get(Object key)

Specified by:

get in interface Map<K,V>

hashCode

public final int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

holder

protected Lazy<? extends Map<K,V>> holder()

Gives access to the internal Lazy instance for derived classes.

Returns:

A reference to m_Holder.

ifPresent

public void ifPresent(Consumer<? super Map<K,V>> consumer)

If this LazyMap instance has been initialised already, the provided Consumer will be executed; otherwise nothing happens.

Specified by:

ifPresent in interface LazyMap<K,V>

Parameters:

consumer - The consumer.

init

public final void init()

Forces the initialisation of this LazyMap instance.

Specified by:

init in interface LazyMap<K,V>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

isPresent

public final boolean isPresent()

Checks whether this LazyMap instance has been initialised already.

Specified by:

isPresent in interface LazyMap<K,V>

Returns:

true if the instance was initialised, false otherwise.

keySet

public final Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

put

public final V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

putAll

public final void putAll(Map<? extends K,? extends V> map)

Specified by:

putAll in interface Map<K,V>

remove

public final V remove(Object key)

Specified by:

remove in interface Map<K,V>

size

public final int size()

Specified by:

size in interface Map<K,V>

toString

public final String toString()

Overrides:

toString in class Object

values

public final Collection<V> values()

Specified by:

values in interface Map<K,V>