Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.internal

Class LazySetImpl<E>

java.lang.Object

org.tquadrat.foundation.util.internal.LazySetImpl<E>

Type Parameters:

E - The type of elements in this set.

All Implemented Interfaces:

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

@ClassVersion(sourceVersion="$Id: LazySetImpl.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class LazySetImpl<E>
extends Object
implements LazySet<E>

The implementation for LazySet.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Lazy<? extends Set<E>>	m_Holder	The holder for the real set.
private final boolean	m_SupplierPopulates	The flag that indicates whether the provided supplier will put values to the set on initialisation.

Constructor Summary

Constructors

Constructor	Description
LazySetImpl(boolean doPopulate, Supplier<? extends Set<E>> supplier)	Creates a new LazySetImpl instance.
LazySetImpl(Set<E> value)	Creates a new LazySetImpl instance that is initialised with the given value.

Method Summary

Modifier and Type	Method	Description
final boolean	add(E e)
final boolean	addAll(Collection<? extends E> c)
final void	clear()
final boolean	contains(Object o)
final boolean	containsAll(Collection<?> c)
final boolean	equals(Object o)
final void	forEach(Consumer<? super E> action)
final int	hashCode()
void	ifPresent(Consumer<? super Set<E>> consumer)	If this LazySet instance has been initialised already, the provided Consumer will be executed; otherwise nothing happens.
final void	init()	Forces the initialisation of this LazySet instance.
final boolean	isEmpty()
final boolean	isPresent()	Checks whether this LazySet instance has been initialised already.
final Iterator<E>	iterator()
final boolean	remove(Object o)
final boolean	removeAll(Collection<?> c)
final boolean	removeIf(Predicate<? super E> filter)
final boolean	retainAll(Collection<?> c)
final int	size()
final Spliterator<E>	spliterator()
final Object[]	toArray()
final <T> T[]	toArray(T[] a)
final String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Field Details

m_Holder

private final Lazy<? extends Set<E>> m_Holder

The holder for the real set.

m_SupplierPopulates

private final boolean m_SupplierPopulates

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

Constructor Details

LazySetImpl

public LazySetImpl(boolean doPopulate,
 Supplier<? extends Set<E>> supplier)

Creates a new LazySetImpl instance.

Parameters:

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

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

LazySetImpl

public LazySetImpl(Set<E> value)

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

Parameters:

value - The initialisation value.

Method Details

add

public final boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

addAll

public final boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

clear

public final void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

contains

public final boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

containsAll

public final boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

equals

public final boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class Object

forEach

public final void forEach(Consumer<? super E> action)

Specified by:

forEach in interface Iterable<E>

hashCode

public final int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface Set<E>

Overrides:

hashCode in class Object

ifPresent

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

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

Specified by:

ifPresent in interface LazySet<E>

Parameters:

consumer - The consumer.

init

public final void init()

Forces the initialisation of this LazySet instance.

Specified by:

init in interface LazySet<E>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

isPresent

public final boolean isPresent()

Checks whether this LazySet instance has been initialised already.

Specified by:

isPresent in interface LazySet<E>

Returns:

true if the instance was initialised, false otherwise.

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

removeAll

public final boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

removeIf

public final boolean removeIf(Predicate<? super E> filter)

Specified by:

removeIf in interface Collection<E>

retainAll

public final boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

size

public final int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

spliterator

public final Spliterator<E> spliterator()

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

Specified by:

spliterator in interface Set<E>

toArray

public final Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toArray

public final <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toString

public final String toString()

Overrides:

toString in class Object