Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.internal

Class HeadTailListImpl<T>

java.lang.Object

org.tquadrat.foundation.util.internal.HeadTailListImpl<T>

Type Parameters:

T - The element type of the list.

All Implemented Interfaces:

Iterable<T>, HeadTailList<T>

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

The implementation for the interface HeadTailList

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.4

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	HeadTailListImpl.IteratorImpl<T>	The implementation of the interface Iterator for instances of HeadTailListImpl

Field Summary

Fields

Modifier and Type	Field	Description
private static final HeadTailList<?>	m_EmptyList	The empty list.
private final int	m_HashCode	The hash code for this instance.
private final T	m_Head	The head element.
private final int	m_Size	The size of the list.
private final HeadTailList<T>	m_Tail	The tail list.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HeadTailListImpl()	Creates the empty HeadTailListImpl instance.
private	HeadTailListImpl(T head, HeadTailList<T> tail)	Creates a new HeadTailListImpl instance.

Method Summary

Modifier and Type	Method	Description
final HeadTailList<T>	add(T element)	Returns a new list with the given element as the head, and this list as the tail.
static final <E> HeadTailList<E>	empty()	Returns an empty list.
final boolean	equals(Object o)
final void	forEachReverse(Consumer<? super T> action)	Does the same as Iterable.forEach(Consumer), but starting with last element first.
final int	hashCode()
final Optional<T>	head()	Returns the head of the list.
private final void	internalForEachReverse(Consumer<? super T> action)	This is the implementation of forEachReverse(Consumer); splitting this into two methods spares the null-check on each invocation.
final boolean	isEmpty()	Checks whether the list is empty.
final Iterator<T>	iterator()
final int	size()	Returns the size of the list.
final Spliterator<T>	spliterator()
final Stream<T>	stream()	Returns a Stream that is backed by this list.
final HeadTailList<T>	tail()	Returns the tail of the list.
final Object[]	toArray()	Returns the contents of this list as an array.
final T[]	toArray(T[] target)	Returns the contents of this list in the provided array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.util.HeadTailList

append, append, contains, get, merge, prepend, prepend, remove, replaceHead, revert, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Details

m_HashCode

private final int m_HashCode

The hash code for this instance.

m_Head

private final T m_Head

The head element.

m_Size

private final int m_Size

The size of the list.

m_Tail

private final HeadTailList<T> m_Tail

The tail list.

m_EmptyList

private static final HeadTailList<?> m_EmptyList

The empty list.

Constructor Details

HeadTailListImpl

private HeadTailListImpl()

Creates the empty HeadTailListImpl instance.

HeadTailListImpl

private HeadTailListImpl(T head,
 HeadTailList<T> tail)

Creates a new HeadTailListImpl instance.

Parameters:

head - The head element.

tail - The tail list.

Method Details

add

public final HeadTailList<T> add(T element)

Returns a new list with the given element as the head, and this list as the tail.

Specified by:

add in interface HeadTailList<T>

Parameters:

element - The head for the new list.

Returns:

The new list.

empty

public static final <E> HeadTailList<E> empty()

Returns an empty list.

Each call to this method will return the same instance.

Type Parameters:

E - The element type for the list.

Returns:

The empty list.

equals

public final boolean equals(Object o)

Specified by:

equals in interface HeadTailList<T>

Overrides:

equals in class Object

forEachReverse

public final void forEachReverse(Consumer<? super T> action)

Does the same as Iterable.forEach(Consumer), but starting with last element first.

Specified by:

forEachReverse in interface HeadTailList<T>

Parameters:

action - The action to perform.

internalForEachReverse

private final void internalForEachReverse(Consumer<? super T> action)

This is the implementation of forEachReverse(Consumer); splitting this into two methods spares the null-check on each invocation.

Parameters:

action - The action.

hashCode

public final int hashCode()

Specified by:

hashCode in interface HeadTailList<T>

Overrides:

hashCode in class Object

head

public final Optional<T> head()

Returns the head of the list.

This will be empty only for the empty list.

Specified by:

head in interface HeadTailList<T>

Returns:

An instance of Optional that holds the head.

isEmpty

public final boolean isEmpty()

Checks whether the list is empty.

Specified by:

isEmpty in interface HeadTailList<T>

Returns:

true if the list is empty, false otherwise.

iterator

public final Iterator<T> iterator()

Specified by:

iterator in interface HeadTailList<T>

Specified by:

iterator in interface Iterable<T>

size

public final int size()

Returns the size of the list.

Specified by:

size in interface HeadTailList<T>

Returns:

The size of the list.

spliterator

public final Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T>

stream

public final Stream<T> stream()

Returns a Stream that is backed by this list.

Specified by:

stream in interface HeadTailList<T>

Returns:

The stream.

tail

public final HeadTailList<T> tail()

Returns the tail of the list.

Specified by:

tail in interface HeadTailList<T>

Returns:

The tail list.

toArray

public final Object[] toArray()

Returns the contents of this list as an array.

Specified by:

toArray in interface HeadTailList<T>

Returns:

The array.

toArray

public final T[] toArray(T[] target)

Returns the contents of this list in the provided array.

If the provided array is larger that the number of elements on the stack, the exceeding entries on that array remained unchanged.

Specified by:

toArray in interface HeadTailList<T>

Parameters:

target - The target array; if this array has an insufficient size, a new array will be created.

Returns:

An array with all entries from the list; never null. If the provided array was large enough to take all elements, it will be returned, otherwise the returned array is a new one and the provided array is unchanged.