ch.awae.utils.collection.immutable

Class List<T>

java.lang.Object

ch.awae.utils.collection.immutable.List<T>

Type Parameters:

T - the element type for the list

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>

public class List<T>
extends java.lang.Object
implements java.lang.Iterable<T>, java.io.Serializable

Immutable Single-Linked List.

Since:

awaeUtils 1.0.1

Author:

Andreas Wälchli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
List(T head, List<? extends T> tail) Creates a new list from a head and a tail.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.Object o) Checks if this list contains a given element
static <T> List<T>	empty() Provides the empty list for any type argument
boolean	equals(java.lang.Object obj)
static <T> List<T>	from(java.util.Collection<T> collection) Creates a new list from a given collection
T	get(int index) Retrieves the element at a given index
int	hashCode()
T	head() Returns the head of the list
boolean	isEmpty() Indicates if this is the empty list
java.util.Iterator<T>	iterator()
static <T> List<T>	of(T... ts) Creates a new list from an array of elements
List<T>	prepend(T element) Creates a new List with the provided element as the head and this list as the tail
int	size() the size of the list
List<? extends T>	tail() Returns the tail of the list
java.lang.Object[]	toArray()
<Type> Type[]	toArray(Type[] a)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

List

public List(T head,
            List<? extends T> tail)

Creates a new list from a head and a tail. The head of a list is the first element, the tail is another list that holds the remaining elements. The list ends with a special empty element

Parameters:

head - the head of the list

tail - the tail. a null tail is interpreted as the empty list.

Method Detail

empty

public static <T> List<T> empty()

Provides the empty list for any type argument

Returns:

the empty list

of

@SafeVarargs
public static <T> List<T> of(T... ts)

Creates a new list from an array of elements

Parameters:

ts - the elements to create a list for

Returns:

the list containing the elements

from

public static <T> List<T> from(java.util.Collection<T> collection)

Creates a new list from a given collection

Parameters:

collection - the collection to convert to a list

Returns:

a list containing the elements of the collection

isEmpty

public boolean isEmpty()

Indicates if this is the empty list

head

public T head()

Returns the head of the list

Returns:

the head

Throws:

java.util.NoSuchElementException - this is the empty list

tail

public List<? extends T> tail()

Returns the tail of the list

Returns:

the tail

Throws:

java.util.NoSuchElementException - this is the empty list

prepend

public List<T> prepend(T element)

Creates a new List with the provided element as the head and this list as the tail

Parameters:

element - the element to prepend

Returns:

a new list

size

public int size()

the size of the list

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

contains

public boolean contains(java.lang.Object o)

Checks if this list contains a given element

Parameters:

o - the element to search

Returns:

true iff the element exists

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

public T get(int index)

Retrieves the element at a given index

Returns:

the element

Throws:

java.lang.IndexOutOfBoundsException - the index is out of bounds

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

toArray

public java.lang.Object[] toArray()

toArray

public <Type> Type[] toArray(Type[] a)