com.bluegosling.collections.immutable

Interface ConsList<E>

Type Parameters:

E - the type of element in the list

All Superinterfaces:

Collection<E>, Iterable<E>, List<E>

All Known Implementing Classes:

AbstractLinkedImmutableList, AbstractLinkedImmutableList.LinkedSubList, LinkedPersistentList

public interface ConsList<E>
extends List<E>

A list that is composed of cons cells. Implementations are generally simple, singly linked lists.

Method Summary

Modifier and Type	Method and Description
default E	car() Returns the first of the list.
default ConsList<E>	cdr() Returns the rest of the list.
E	first() Returns the first element in the list.
ConsList<E>	rest() Returns the rest of the list, excluding the first element.
ConsList<E>	subList(int fromIndex, int toIndex)

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

first

E first()

Returns the first element in the list. If this list is empty (aka nil) then an exception is thrown.

Returns:

the first element in the list

Throws:

NoSuchElementException - if this list is empty

rest

ConsList<E> rest()

Returns the rest of the list, excluding the first element. If this list is empty (aka nil) then an exception is thrown.

Returns:

the rest of the list, not including the first element

Throws:

NoSuchElementException - if this list is empty

car

default E car()

Returns the first of the list. This is a synonym for first().

Returns:

the first element in the list

Throws:

NoSuchElementException - if this list is empty

cdr

default ConsList<E> cdr()

Returns the rest of the list. This is a synonym for rest().

Returns:

the rest of the list, not including the first element

Throws:

NoSuchElementException - if this list is empty

subList

ConsList<E> subList(int fromIndex,
                    int toIndex)

A sub-list of a ConsList is also a ConsList.

Specified by:

subList in interface List<E>

See Also:

List.subList(int, int)