com.alee.utils.collection

Class ImmutableList<E>

java.lang.Object

com.alee.utils.collection.ImmutableList<E>

Type Parameters:

E - data type

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>

public class ImmutableList<E>
extends Object
implements List<E>, Cloneable, Serializable

List implementation that doesn't allow any data modifications to be done. Unlike Collections.unmodifiableList(List) this implementation keeps list data copy. If you need to provide an unmodifiable reference for your list use Collections implementation.

Author:

Mikle Garin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected E[]	data List data.

Constructor Summary

Constructors

Constructor and Description
ImmutableList(Collection<? extends E> collection) Constructs new ImmutableList based on the specified Collection.
ImmutableList(E... data) Constructs new ImmutableList based on the specified list data.

Method Summary

Modifier and Type	Method and Description
boolean	add(E element)
void	add(int index, E element)
boolean	addAll(Collection<? extends E> collection)
boolean	addAll(int index, Collection<? extends E> c)
void	clear()
boolean	contains(Object element)
boolean	containsAll(Collection<?> collection)
protected UnsupportedOperationException	createModificationException() Returns new UnsupportedOperationException instance specific for this implementation.
boolean	equals(Object o)
E	get(int index)
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<E>	iterator()
int	lastIndexOf(Object o)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(Object element)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
E	set(int index, E element)
int	size()
List<E>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] array)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

data

@NotNull
protected final E[] data

List data.

Constructor Detail

ImmutableList

public ImmutableList(@NotNull
                     E... data)

Constructs new ImmutableList based on the specified list data.

Parameters:

data - data array

ImmutableList

public ImmutableList(@NotNull
                     Collection<? extends E> collection)

Constructs new ImmutableList based on the specified Collection.

Parameters:

collection - data Collection

Method Detail

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

contains

public boolean contains(@Nullable
                        Object element)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

toArray

@NotNull
public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

iterator

@NotNull
public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface List<E>

add

public boolean add(@Nullable
                   E element)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

remove

public boolean remove(@Nullable
                      Object element)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

containsAll

public boolean containsAll(@NotNull
                           Collection<?> collection)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

addAll

public boolean addAll(@NotNull
                      Collection<? extends E> collection)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

removeAll

public boolean removeAll(@NotNull
                         Collection<?> collection)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

retainAll

public boolean retainAll(@NotNull
                         Collection<?> collection)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

get

@Nullable
public E get(int index)

Specified by:

get in interface List<E>

set

@Nullable
public E set(int index,
                       @Nullable
                       E element)

Specified by:

set in interface List<E>

add

public void add(int index,
                @Nullable
                E element)

Specified by:

add in interface List<E>

remove

@Nullable
public E remove(int index)

Specified by:

remove in interface List<E>

indexOf

public int indexOf(@Nullable
                   Object o)

Specified by:

indexOf in interface List<E>

lastIndexOf

public int lastIndexOf(@Nullable
                       Object o)

Specified by:

lastIndexOf in interface List<E>

addAll

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

Specified by:

addAll in interface List<E>

listIterator

@NotNull
public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

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

Specified by:

listIterator in interface List<E>

subList

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

Specified by:

subList in interface List<E>

createModificationException

@NotNull
protected UnsupportedOperationException createModificationException()

Returns new UnsupportedOperationException instance specific for this implementation.

Returns:

new UnsupportedOperationException instance specific for this implementation

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(@Nullable
                      Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

toString

@NotNull
public String toString()

Overrides:

toString in class Object