Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util

Interface LazySet<E>

Type Parameters:

E - The type of elements in this set.

All Superinterfaces:

Collection<E>, Iterable<E>, Set<E>

All Known Implementing Classes:

LazySetImpl

@ClassVersion(sourceVersion="$Id: LazySet.java 1032 2022-04-10 17:27:44Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public sealed interface LazySet<E>
extends Set<E>
permits LazySetImpl<E>

The interface for a Set that will be initialised only when required.

Note:

• There is no implementation of a map() method in this interface because it is assumed that this would be confusing: such a map() method would operate on the whole list that is wrapped by this value, and not on an entry as one would expect. Refer to .

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: LazySet.java 1032 2022-04-10 17:27:44Z tquadrat $

Since:

0.0.5

See Also:

• Lazy

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.LazySet"

⁠

Method Summary

Modifier and Type	Method	Description
void	ifPresent(Consumer<? super Set<E>> consumer)	If this LazySet instance has been initialised already, the provided Consumer will be executed; otherwise nothing happens.
void	init()	Forces the initialisation of this LazySet instance.
boolean	isPresent()	Checks whether this LazySet instance has been initialised already.
static <E> LazySet<E>	of(Set<E> value)	Creates a new LazySet instance that is already initialised.
static <E> LazySet<E>	use(boolean doPopulate, Supplier<? extends Set<E>> supplier)	Creates a new LazySet instance that uses the given supplier to initialise.
static <E> LazySet<E>	use(Supplier<? extends Set<E>> supplier)	Creates a new LazySet instance that uses the given supplier to create the internal map, but that supplier does not provide values on initialisation.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Method Details

ifPresent

void ifPresent(Consumer<? super Set<E>> consumer)

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

Parameters:

consumer - The consumer.

init

void init()

Forces the initialisation of this LazySet instance.

isPresent

boolean isPresent()

Checks whether this LazySet instance has been initialised already.

Returns:

true if the instance was initialised, false otherwise.

of

@API(status=STABLE,
     since="0.0.5")
static <E> LazySet<E> of(Set<E> value)

Creates a new LazySet instance that is already initialised.

Type Parameters:

E - The type of elements in this set.

Parameters:

value - The value.

Returns:

The new instance.

use

@API(status=STABLE,
     since="0.0.5")
static <E> LazySet<E> use(Supplier<? extends Set<E>> supplier)

Creates a new LazySet instance that uses the given supplier to create the internal map, but that supplier does not provide values on initialisation.

Type Parameters:

E - The type of elements in this set.

Parameters:

supplier - The supplier that initialises for the new instance of LazySet when needed.

Returns:

The new instance.

use

@API(status=STABLE,
     since="0.0.5")
static <E> LazySet<E> use(boolean doPopulate,
 Supplier<? extends Set<E>> supplier)

Creates a new LazySet instance that uses the given supplier to initialise.

Type Parameters:

E - The type of elements in this set.

Parameters:

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

supplier - The supplier that initialises for the new instance of LazySet when needed.

Returns:

The new instance.