Class ImmutableList<A>

java.lang.Object

java.util.AbstractCollection<A>

com.strobel.collections.ImmutableList<A>

All Implemented Interfaces:

Iterable<A>, Collection<A>, List<A>, SequencedCollection<A>

public class ImmutableList<A>
extends AbstractCollection<A>
implements List<A>

A class for generic linked lists. Links are supposed to be immutable, the only exception being the incremental construction of lists via ListBuffers. List is the main container class in GJC. Most data structures and algorithms in GJC use lists rather than arrays.

Lists are always trailed by a sentinel element, whose head and tail are both null.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Iterator<?>	EMPTY_ITERATOR
private static final ImmutableList<?>	EMPTY_LIST
A	head	The first element of the list, supposed to be immutable.
ImmutableList<A>	tail	The remainder of the list except for its first element, supposed to be immutable.

Constructor Summary

Constructors

Constructor	Description
ImmutableList(A head, ImmutableList<A> tail)	Construct a list given its head and tail.

Method Summary

Modifier and Type	Method	Description
void	add(int index, A element)
boolean	addAll(int index, Collection<? extends A> c)
ImmutableList<A>	append(A x)	Append given element at length, forming and returning a new list.
ImmutableList<A>	appendList(ImmutableList<A> x)	Append given list at length, forming and returning a new list.
ImmutableList<A>	appendList(ListBuffer<A> x)	Append given list buffer at length, forming and returning a new list.
boolean	contains(Object x)	Does the list contain the specified element?
static <T> ImmutableList<T>	convert(Class<T> type, ImmutableList<?> list)
static <A> ImmutableList<A>	empty()	Construct an empty list.
private static <A> Iterator<A>	emptyIterator()
static boolean	equals(ImmutableList<?> xs, ImmutableList<?> ys)	Are the two lists the same?
boolean	equals(Object other)	Is this list the same as other list?
static <A> ImmutableList<A>	fill(int len, A init)	Deprecated.
static <A> ImmutableList<A>	from(A[] array)	Construct a list consisting all elements of given array.
A	get(int index)
int	hashCode()	Compute a hash code, overrides Object
int	indexOf(Object o)
boolean	isEmpty()	Does list have no elements?
Iterator<A>	iterator()
A	last()	The last element in the list, if any, or null.
int	lastIndexOf(Object o)
int	length()	Return the number of elements in this list.
ListIterator<A>	listIterator()
ListIterator<A>	listIterator(int index)
boolean	nonEmpty()	Does list have elements?
static <A> ImmutableList<A>	of(A x1)	Construct a list consisting of given element.
static <A> ImmutableList<A>	of(A x1, A x2)	Construct a list consisting of given elements.
static <A> ImmutableList<A>	of(A x1, A... rest)	Construct a list consisting of given elements.
static <A> ImmutableList<A>	of(A x1, A x2, A x3)	Construct a list consisting of given elements.
static <A> ImmutableList<A>	of(A x1, A x2, A x3, A... rest)	Construct a list consisting of given elements.
ImmutableList<A>	prepend(A x)	Prepend given element to front of list, forming and returning a new list.
ImmutableList<A>	prependList(ImmutableList<A> xs)	Prepend given list of elements to front of list, forming and returning a new list.
A	remove(int index)
ImmutableList<A>	reverse()	Reverse list.
A	set(int index, A element)
ImmutableList<A>	setTail(ImmutableList<A> tail)
int	size()
List<A>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] vec)	Copy successive elements of this list into given vector until list is exhausted or end of vector is reached.
String	toString()	Form a string listing all elements with comma as the separator character.
String	toString(String sep)	Form a string listing all elements with given separator character.

Methods inherited from class AbstractCollection

add, addAll, clear, containsAll, remove, removeAll, retainAll

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

add, addAll, addFirst, addLast, clear, containsAll, getFirst, getLast, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator

Field Details

head

public A head

The first element of the list, supposed to be immutable.

tail

public ImmutableList<A> tail

The remainder of the list except for its first element, supposed to be immutable.

EMPTY_LIST

private static final ImmutableList<?> EMPTY_LIST

EMPTY_ITERATOR

private static final Iterator<?> EMPTY_ITERATOR

Constructor Details

ImmutableList

ImmutableList(A head,
 ImmutableList<A> tail)

Construct a list given its head and tail.

Method Details

empty

public static <A> ImmutableList<A> empty()

Construct an empty list.

of

public static <A> ImmutableList<A> of(A x1)

Construct a list consisting of given element.

of

@SafeVarargs
public static <A> ImmutableList<A> of(A x1,
 A... rest)

Construct a list consisting of given elements.

of

public static <A> ImmutableList<A> of(A x1,
 A x2)

Construct a list consisting of given elements.

of

public static <A> ImmutableList<A> of(A x1,
 A x2,
 A x3)

Construct a list consisting of given elements.

of

public static <A> ImmutableList<A> of(A x1,
 A x2,
 A x3,
 A... rest)

Construct a list consisting of given elements.

from

public static <A> ImmutableList<A> from(A[] array)

Construct a list consisting all elements of given array.

Parameters:

array - an array; if null return an empty list

fill

@Deprecated
public static <A> ImmutableList<A> fill(int len,
 A init)

Deprecated.

Construct a list consisting of a given number of identical elements.

Parameters:

len - The number of elements in the list.

init - The value of each element.

isEmpty

public boolean isEmpty()

Does list have no elements?

Specified by:

isEmpty in interface Collection<A>

Specified by:

isEmpty in interface List<A>

Overrides:

isEmpty in class AbstractCollection<A>

nonEmpty

public boolean nonEmpty()

Does list have elements?

length

public int length()

Return the number of elements in this list.

size

public int size()

Specified by:

size in interface Collection<A>

Specified by:

size in interface List<A>

Specified by:

size in class AbstractCollection<A>

setTail

public ImmutableList<A> setTail(ImmutableList<A> tail)

prepend

public ImmutableList<A> prepend(A x)

Prepend given element to front of list, forming and returning a new list.

prependList

public ImmutableList<A> prependList(ImmutableList<A> xs)

Prepend given list of elements to front of list, forming and returning a new list.

reverse

public ImmutableList<A> reverse()

Reverse list. If the list is empty or a singleton, then the same list is returned. Otherwise a new list is formed.

append

public ImmutableList<A> append(A x)

Append given element at length, forming and returning a new list.

appendList

public ImmutableList<A> appendList(ImmutableList<A> x)

Append given list at length, forming and returning a new list.

appendList

public ImmutableList<A> appendList(ListBuffer<A> x)

Append given list buffer at length, forming and returning a new list.

toArray

@NotNull
public <T> T[] toArray(@NotNull
 T[] vec)

Copy successive elements of this list into given vector until list is exhausted or end of vector is reached.

Specified by:

toArray in interface Collection<A>

Specified by:

toArray in interface List<A>

Overrides:

toArray in class AbstractCollection<A>

toArray

@NotNull
public Object[] toArray()

Specified by:

toArray in interface Collection<A>

Specified by:

toArray in interface List<A>

Overrides:

toArray in class AbstractCollection<A>

toString

public String toString(String sep)

Form a string listing all elements with given separator character.

toString

public String toString()

Form a string listing all elements with comma as the separator character.

Overrides:

toString in class AbstractCollection<A>

hashCode

public int hashCode()

Compute a hash code, overrides Object

Specified by:

hashCode in interface Collection<A>

Specified by:

hashCode in interface List<A>

Overrides:

hashCode in class Object

See Also:

• List.hashCode()

equals

public boolean equals(Object other)

Is this list the same as other list?

Specified by:

equals in interface Collection<A>

Specified by:

equals in interface List<A>

Overrides:

equals in class Object

See Also:

• List.equals(Object)

equals

public static boolean equals(ImmutableList<?> xs,
 ImmutableList<?> ys)

Are the two lists the same?

contains

public boolean contains(Object x)

Does the list contain the specified element?

Specified by:

contains in interface Collection<A>

Specified by:

contains in interface List<A>

Overrides:

contains in class AbstractCollection<A>

last

public A last()

The last element in the list, if any, or null.

convert

public static <T> ImmutableList<T> convert(Class<T> type,
 ImmutableList<?> list)

emptyIterator

private static <A> Iterator<A> emptyIterator()

iterator

@NotNull
public Iterator<A> iterator()

Specified by:

iterator in interface Collection<A>

Specified by:

iterator in interface Iterable<A>

Specified by:

iterator in interface List<A>

Specified by:

iterator in class AbstractCollection<A>

get

public A get(int index)

Specified by:

get in interface List<A>

addAll

public boolean addAll(int index,
 @NotNull
 Collection<? extends A> c)

Specified by:

addAll in interface List<A>

set

public A set(int index,
 A element)

Specified by:

set in interface List<A>

add

public void add(int index,
 A element)

Specified by:

add in interface List<A>

remove

public A remove(int index)

Specified by:

remove in interface List<A>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<A>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<A>

listIterator

@NotNull
public ListIterator<A> listIterator()

Specified by:

listIterator in interface List<A>

listIterator

@NotNull
public ListIterator<A> listIterator(int index)

Specified by:

listIterator in interface List<A>

subList

@NotNull
public List<A> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<A>