net.pwall.util

Class ImmutableList<T>

java.lang.Object

net.pwall.util.ImmutableBase<A>

net.pwall.util.ImmutableCollectionBase<T,T>

net.pwall.util.ImmutableCollection<T>

net.pwall.util.ImmutableList<T>

Type Parameters:

T - the list element type

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, RandomAccess

public class ImmutableList<T>
extends ImmutableCollection<T>
implements List<T>, RandomAccess

Immutable implementation of List.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
ImmutableList(T[] array) Construct an ImmutableList with the given array (using the entire array).
ImmutableList(T[] array, int length) Construct an ImmutableList with the given array and length.

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element) Modifying operation - not allowed.
boolean	addAll(int index, Collection<? extends T> c) Modifying operation - not allowed.
static <TT> ImmutableList<TT>	emptyList() Get an empty ImmutableList.
boolean	equals(Object other) Compares the specified object with this list for equality.
T	get(int index) Get the element at the specified index.
int	hashCode() Returns the hash code value for this list.
int	indexOf(Object o) Find the index in the list of the first item equal to the given object (either both null, or equal according to Object.equals(java.lang.Object)).
int	lastIndexOf(Object o) Find the index in the list of the last item equal to the given object (either both null, or equal according to Object.equals(java.lang.Object)).
ListIterator<T>	listIterator() Get a ListIterator over this list.
ListIterator<T>	listIterator(int index) Get a ListIterator over this list, initialised to the given index.
static <TT> ImmutableList<TT>	listOf(TT[] array) Get an ImmutableList using the supplied array.
static <TT> ImmutableList<TT>	listOf(TT[] array, int length) Get an ImmutableList using the supplied array.
T	remove(int index) Modifying operation - not allowed.
T	set(int index, T element) Modifying operation - not allowed.
ImmutableList<T>	subList(int fromIndex, int toIndex) Get a sub-list of this list.

Methods inherited from class net.pwall.util.ImmutableCollection

contains, contains, iterator, toArray, toArray

Methods inherited from class net.pwall.util.ImmutableCollectionBase

add, addAll, containsAll, remove, removeAll, retainAll, toString

Methods inherited from class net.pwall.util.ImmutableBase

clear, isEmpty, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ImmutableList

public ImmutableList(T[] array,
                     int length)

Construct an ImmutableList with the given array and length.

Parameters:

array - the array

length - the length (the number of array items to be considered part of the list)

Throws:

IndexOutOfBoundsException - if the length is less than 0 or greater than the array length

ImmutableList

public ImmutableList(T[] array)

Construct an ImmutableList with the given array (using the entire array).

Parameters:

array - the array

Method Detail

get

public T get(int index)

Get the element at the specified index. The function does not check the array index because the indexing operation on the array will do that anyway.

Specified by:

get in interface List<T>

Parameters:

index - the index

Returns:

the element at that index

Throws:

IndexOutOfBoundsException - if the index is less than 0 or greater than the length of the list

indexOf

public int indexOf(Object o)

Find the index in the list of the first item equal to the given object (either both null, or equal according to Object.equals(java.lang.Object)).

Specified by:

indexOf in interface List<T>

Parameters:

o - the object to be located

Returns:

the index, or -1 if not found

lastIndexOf

public int lastIndexOf(Object o)

Find the index in the list of the last item equal to the given object (either both null, or equal according to Object.equals(java.lang.Object)).

Specified by:

lastIndexOf in interface List<T>

Parameters:

o - the object to be located

Returns:

the index, or -1 if not found

listIterator

public ListIterator<T> listIterator()

Get a ListIterator over this list.

Specified by:

listIterator in interface List<T>

Returns:

the ListIterator

listIterator

public ListIterator<T> listIterator(int index)

Get a ListIterator over this list, initialised to the given index.

Specified by:

listIterator in interface List<T>

Parameters:

index - the starting index

Returns:

the ListIterator

subList

public ImmutableList<T> subList(int fromIndex,
                                int toIndex)

Get a sub-list of this list.

Specified by:

subList in interface List<T>

Parameters:

fromIndex - the starting index of the sub-list

toIndex - the ending index of the sub-list

Returns:

the sub-list

Throws:

IndexOutOfBoundsException - if the index range is not valid

add

public void add(int index,
                T element)

Modifying operation - not allowed.

Specified by:

add in interface List<T>

Throws:

UnsupportedOperationException - (in all cases)

set

public T set(int index,
             T element)

Modifying operation - not allowed.

Specified by:

set in interface List<T>

Throws:

UnsupportedOperationException - (in all cases)

addAll

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

Modifying operation - not allowed.

Specified by:

addAll in interface List<T>

Throws:

UnsupportedOperationException - (in all cases)

remove

public T remove(int index)

Modifying operation - not allowed.

Specified by:

remove in interface List<T>

Throws:

UnsupportedOperationException - (in all cases)

equals

public boolean equals(Object other)

Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal (that is, both are null or they compare as equal using Object.equals(java.lang.Object)). This definition ensures that the Object.equals(java.lang.Object) method works properly across different implementations of the List interface.

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Overrides:

equals in class Object

Parameters:

other - the object to be compared for equality with this list

Returns:

true if the specified object is equal to this list

hashCode

public int hashCode()

Returns the hash code value for this list.

This implementation uses exactly the code that is used to define the list hash function in the documentation for the List.hashCode() method.

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Overrides:

hashCode in class Object

Returns:

the hash code value for this list

emptyList

public static <TT> ImmutableList<TT> emptyList()

Get an empty ImmutableList. This avoids a memory allocation if the list is empty.

Type Parameters:

TT - the element type

Returns:

an empty list

listOf

public static <TT> ImmutableList<TT> listOf(TT[] array)

Get an ImmutableList using the supplied array. If the array length is zero, the empty list is returned.

Type Parameters:

TT - the element type

Parameters:

array - the array

Returns:

the list

listOf

public static <TT> ImmutableList<TT> listOf(TT[] array,
                                            int length)

Get an ImmutableList using the supplied array. If the array length is zero, the empty list is returned.

Type Parameters:

TT - the element type

Parameters:

array - the array

length - the length (the number of array items to be considered part of the list)

Returns:

the list