eu.simuline.util

Class CollectionsExt.ImmutableList<E>

java.lang.Object

java.util.AbstractCollection<E>

eu.simuline.util.CollectionsExt.AbstractImmutableCollection<List<E>,E>

eu.simuline.util.CollectionsExt.ImmutableList<E>

Type Parameters:

E - the class of the elements of this list.

All Implemented Interfaces:

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

Enclosing class:

CollectionsExt<E>

public static final class CollectionsExt.ImmutableList<E>
extends CollectionsExt.AbstractImmutableCollection<List<E>,E>
implements List<E>

A list which prevents being modified by throwing an exception for the modifying methods.

Field Summary

Fields

Modifier and Type	Field and Description
private List<E>	list The enclosed list containing the elements of this list.

Constructor Summary

Constructors

Constructor and Description
ImmutableList(List<E> list)
ImmutableList(Set<CollectionsExt.Modification> mods, List<E> list)

Method Summary

Modifier and Type	Method and Description
void	add(int index, E obj)
boolean	addAll(int index, Collection<? extends E> coll)
boolean	equals(Object obj)
E	get(int index)
int	hashCode()
int	indexOf(Object obj)
int	lastIndexOf(Object obj)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
E	remove(int index)
void	replaceAll(UnaryOperator<E> operator)
E	set(int index, E element)
void	sort(Comparator<? super E> cmp)
List<E>	subList(int fromIndex, int toIndex)
List<E>	unrestricted() Returns the underlying set without the restrictions imposed by this CollectionsExt.ImmutableCollection.

Methods inherited from class eu.simuline.util.CollectionsExt.AbstractImmutableCollection

add, addAll, allowedModifications, allowModification, allowModifications, clear, iterator, remove, removeAll, removeIf, retainAll, size, toString

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, toArray, toArray

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, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

list

private final List<E> list

The enclosed list containing the elements of this list.

Constructor Detail

ImmutableList

ImmutableList(List<E> list)

ImmutableList

ImmutableList(Set<CollectionsExt.Modification> mods,
              List<E> list)

Method Detail

unrestricted

public List<E> unrestricted()

Description copied from class: CollectionsExt.AbstractImmutableCollection

Returns the underlying set without the restrictions imposed by this CollectionsExt.ImmutableCollection. Note that the result may still throw UnsupportedOperationExceptions depending on the implementation.

Specified by:

unrestricted in class CollectionsExt.AbstractImmutableCollection<List<E>,E>

add

public void add(int index,
                E obj)

Specified by:

add in interface List<E>

Throws:

UnsupportedOperationException - if either unrestricted() does not allow this operation or AddObj is no allowed operation according to CollectionsExt.AbstractImmutableCollection.allowedModifications().

addAll

public boolean addAll(int index,
                      Collection<? extends E> coll)

Specified by:

addAll in interface List<E>

Throws:

UnsupportedOperationException - if either unrestricted() does not allow this operation or AddObj is no allowed operation according to CollectionsExt.AbstractImmutableCollection.allowedModifications(). In the latter case it does not matter, whether effectively it is tried to add objects which is the case only coll is not empty.

get

public E get(int index)

Specified by:

get in interface List<E>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

indexOf

public int indexOf(Object obj)

Specified by:

indexOf in interface List<E>

lastIndexOf

public int lastIndexOf(Object obj)

Specified by:

lastIndexOf in interface List<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

Throws:

UnsupportedOperationException - if either unrestricted() does not allow this operation or RemoveObj is no allowed operation according to CollectionsExt.AbstractImmutableCollection.allowedModifications().

set

public E set(int index,
             E element)

Specified by:

set in interface List<E>

Throws:

UnsupportedOperationException - if either unrestricted() does not allow this operation or SetObj is no allowed operation according to CollectionsExt.AbstractImmutableCollection.allowedModifications(). In the latter case it does not matter, whether effectively it is tried to set an object which is the case only if element is not at place index in this.

replaceAll

public void replaceAll(UnaryOperator<E> operator)

Specified by:

replaceAll in interface List<E>

Throws:

UnsupportedOperationException - if either unrestricted() does not allow this operation or SetObj is no allowed operation according to CollectionsExt.AbstractImmutableCollection.allowedModifications(). In the latter case it does not matter, whether effectively it is tried to replace an object which is the case only if operator really changes an object.

sort

public void sort(Comparator<? super E> cmp)

Specified by:

sort in interface List<E>

Throws:

UnsupportedOperationException - if either unrestricted() does not allow this operation or SetObj is no allowed operation according to CollectionsExt.AbstractImmutableCollection.allowedModifications(). In the latter case it does not matter, whether effectively it is tried to replace an object which is the case only if this is not completely sorted according to cmp. This definition is in conjunction with the requirement, of List.sort(Comparator) that this exception is thrown iff the list iterator does not permit the ListIterator.set(Object) method.

subList

public List<E> subList(int fromIndex,
                       int toIndex)

Specified by:

subList in interface List<E>