org.infinispan.commons.util

Class ImmutableListCopy<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.infinispan.commons.util.ImmutableListCopy<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, Immutables.Immutable

@Immutable
public class ImmutableListCopy<E>
extends AbstractList<E>
implements Immutables.Immutable

A lightweight, read-only copy of a List. Typically used in place of the common idiom: return Collections.unmodifiableList(new ArrayList( myInternalList ));

a it is far more efficient than making a defensive copy and then wrapping the defensive copy in a read-only wrapper.

Also used whenever a read-only reference List is needed.

Since:

4.0

Author:

Manik Surtani (manik@jboss.org)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableListCopy() Constructs a new ImmutableListCopy.
ImmutableListCopy(Collection<? extends E> c) Only one copy constructor since the list is immutable.
ImmutableListCopy(Collection<? extends E> collection1, Collection<? extends E> collection2) Utility constructors to allow combining collections
ImmutableListCopy(E[] array) Assumes that the array passed in is "safe", i.e., is not referenced from elsewhere.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E o)
boolean	addAll(Collection<? extends E> c)
boolean	addAll(int index, Collection<? extends E> c)
boolean	contains(Object o)
E	get(int index)
int	indexOf(Object o)
boolean	isEmpty()
Iterator<E>	iterator()
int	lastIndexOf(Object o)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
void	readExternal(ObjectInput in) See ImmutableListCopy.writeExternal(java.io.ObjectOutput) for serialization format
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
List<E>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
void	writeExternal(ObjectOutput out) Format: - entry array size (int) - elements (Object)

Constructor Detail

ImmutableListCopy

public ImmutableListCopy()

Constructs a new ImmutableListCopy. Required by Serialization.

ImmutableListCopy

public ImmutableListCopy(Collection<? extends E> c)

Only one copy constructor since the list is immutable.

Parameters:

c - collection to copy from

ImmutableListCopy

public ImmutableListCopy(E[] array)

Assumes that the array passed in is "safe", i.e., is not referenced from elsewhere. Use with care!

Parameters:

array - to reference

ImmutableListCopy

public ImmutableListCopy(Collection<? extends E> collection1,
                 Collection<? extends E> collection2)

Utility constructors to allow combining collections

Parameters:

collection1 - collection to copy from

collection2 - collection to copy from

Method Detail

size

public final int size()

Specified by:

size in class AbstractCollection<E>

isEmpty

public final boolean isEmpty()

Overrides:

isEmpty in class AbstractCollection<E>

contains

public final boolean contains(Object o)

Overrides:

contains in class AbstractCollection<E>

iterator

public final Iterator<E> iterator()

Overrides:

iterator in class AbstractList<E>

toArray

public final Object[] toArray()

Overrides:

toArray in class AbstractCollection<E>

toArray

public final <T> T[] toArray(T[] a)

Overrides:

toArray in class AbstractCollection<E>

add

public final boolean add(E o)

Overrides:

add in class AbstractList<E>

remove

public final boolean remove(Object o)

Overrides:

remove in class AbstractCollection<E>

addAll

public final boolean addAll(Collection<? extends E> c)

Overrides:

addAll in class AbstractCollection<E>

addAll

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

Overrides:

addAll in class AbstractList<E>

removeAll

public final boolean removeAll(Collection<?> c)

Overrides:

removeAll in class AbstractCollection<E>

retainAll

public final boolean retainAll(Collection<?> c)

Overrides:

retainAll in class AbstractCollection<E>

get

public final E get(int index)

Specified by:

get in class AbstractList<E>

indexOf

public final int indexOf(Object o)

Overrides:

indexOf in class AbstractList<E>

lastIndexOf

public final int lastIndexOf(Object o)

Overrides:

lastIndexOf in class AbstractList<E>

listIterator

public final ListIterator<E> listIterator()

Overrides:

listIterator in class AbstractList<E>

listIterator

public final ListIterator<E> listIterator(int index)

Overrides:

listIterator in class AbstractList<E>

subList

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

Overrides:

subList in class AbstractList<E>

writeExternal

public void writeExternal(ObjectOutput out)

Format: - entry array size (int) - elements (Object)

Parameters:

out - stream to write to

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)

See ImmutableListCopy.writeExternal(java.io.ObjectOutput) for serialization format

Parameters:

in - stream

Throws:

IOException

ClassNotFoundException