Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.internal

Class LazyListImpl<E>

java.lang.Object

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

Type Parameters:

E - The type of elements in this list.

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, SequencedCollection<E>, LazyList<E>

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

The implementation for LazyList.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Lazy<? extends List<E>>	m_Holder	The holder for the real list.
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
LazyListImpl(boolean doPopulate, Supplier<? extends List<E>> supplier)	Creates a new LazyListImpl instance.
LazyListImpl(List<E> value)	Creates a new LazyListImpl instance that is initialised with the given value.

Method Summary

Modifier and Type	Method	Description
final void	add(int index, E element)
final boolean	add(E e)
final boolean	addAll(int index, Collection<? extends E> c)
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 E	get(int index)
final int	hashCode()
final void	ifPresent(Consumer<? super List<E>> consumer)	If this LazyList instance has been initialised already, the provided Consumer will be executed; otherwise nothing happens.
final int	indexOf(Object o)
final void	init()	Forces the initialisation of this LazyList instance.
final boolean	isEmpty()
final boolean	isPresent()	Checks whether this LazyList instance has been initialised already.
final Iterator<E>	iterator()
final int	lastIndexOf(Object o)
final ListIterator<E>	listIterator()
final ListIterator<E>	listIterator(int index)
final E	remove(int index)
final boolean	remove(Object o)
final boolean	removeAll(Collection<?> c)
final boolean	removeIf(Predicate<? super E> filter)
final void	replaceAll(UnaryOperator<E> operator)
final boolean	retainAll(Collection<?> c)
final E	set(int index, E element)
final int	size()
final void	sort(Comparator<? super E> c)
final Spliterator<E>	spliterator()
final List<E>	subList(int fromIndex, int toIndex)
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

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed

Field Details

m_Holder

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

The holder for the real list.

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

LazyListImpl

public LazyListImpl(boolean doPopulate,
 Supplier<? extends List<E>> supplier)

Creates a new LazyListImpl instance.

Parameters:

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

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

LazyListImpl

public LazyListImpl(List<E> value)

Creates a new LazyListImpl 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 List<E>

add

public final void add(int index,
 E element)

Specified by:

add in interface List<E>

addAll

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

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

addAll

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

Specified by:

addAll in interface List<E>

clear

public final void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

contains

public final boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

containsAll

public final boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

equals

public final boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

forEach

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

Specified by:

forEach in interface Iterable<E>

get

public final E get(int index)

Specified by:

get in interface List<E>

ifPresent

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

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

Specified by:

ifPresent in interface LazyList<E>

Parameters:

consumer - The consumer.

indexOf

public final int indexOf(Object o)

Specified by:

indexOf in interface List<E>

hashCode

public final int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Object

init

public final void init()

Forces the initialisation of this LazyList instance.

Specified by:

init in interface LazyList<E>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

isPresent

public final boolean isPresent()

Checks whether this LazyList instance has been initialised already.

Specified by:

isPresent in interface LazyList<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 List<E>

lastIndexOf

public final int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<E>

listIterator

public final ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

public final ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

remove

public final E remove(int index)

Specified by:

remove in interface List<E>

removeAll

public final boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

removeIf

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

Specified by:

removeIf in interface Collection<E>

replaceAll

public final void replaceAll(UnaryOperator<E> operator)

Specified by:

replaceAll in interface List<E>

retainAll

public final boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

set

public final E set(int index,
 E element)

Specified by:

set in interface List<E>

size

public final int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

sort

public final void sort(Comparator<? super E> c)

Specified by:

sort in interface LazyList<E>

Specified by:

sort in interface List<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 List<E>

subList

public final List<E> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<E>

toArray

public final Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toString

public final String toString()

Overrides:

toString in class Object