com.alee.utils.collection

Class ImmutableCollection<E>

java.lang.Object

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

Type Parameters:

E - data type

All Implemented Interfaces:

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

public class ImmutableCollection<E>
extends Object
implements Collection<E>, Cloneable, Serializable

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

Author:

Mikle Garin

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	add(E element)
boolean	addAll(Collection<? extends E> collection)
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)
int	hashCode()
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(Object element)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
int	size()
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.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

data

@NotNull
protected final E[] data

Collection data.

Constructor Detail

ImmutableCollection

public ImmutableCollection(@NotNull
                           E... data)

Constructs new ImmutableCollection based on the specified collection data.

Parameters:

data - collection data

ImmutableCollection

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

Constructs new ImmutableCollection based on the specified Collection.

Parameters:

collection - Collection

Method Detail

size

public int size()

Specified by:

size in interface Collection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

contains

public boolean contains(@Nullable
                        Object element)

Specified by:

contains in interface Collection<E>

toArray

@NotNull
public Object[] toArray()

Specified by:

toArray in interface Collection<E>

toArray

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

Specified by:

toArray in interface Collection<E>

iterator

@NotNull
public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

add

public boolean add(@Nullable
                   E element)

Specified by:

add in interface Collection<E>

remove

public boolean remove(@Nullable
                      Object element)

Specified by:

remove in interface Collection<E>

containsAll

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

Specified by:

containsAll in interface Collection<E>

addAll

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

Specified by:

addAll in interface Collection<E>

removeAll

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

Specified by:

removeAll in interface Collection<E>

retainAll

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

Specified by:

retainAll in interface Collection<E>

clear

public void clear()

Specified by:

clear in interface Collection<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>

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object o)

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

toString

@NotNull
public String toString()

Overrides:

toString in class Object