javolution.util.internal.collection

Class SharedCollectionImpl<E>

java.lang.Object

javolution.util.FastCollection<E>

javolution.util.MutableList<E>

javolution.util.internal.collection.SharedCollectionImpl<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, Realtime, Reusable, XMLSerializable

public final class SharedCollectionImpl<E>
extends MutableList<E>
implements java.util.List<E>, Reusable

A shared view over a collection (reads-write locks).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javolution.util.FastCollection

FastCollection.Record

Constructor Summary

Constructors

Constructor and Description
SharedCollectionImpl(MutableList<E> inner)

Method Summary

Modifier and Type	Method and Description
boolean	add(E o) Appends the specified value to the end of this collection (optional operation).
void	add(int index, E element)
boolean	addAll(java.util.Collection<? extends E> c) Appends all of the values in the specified collection to the end of this collection, in the order that they are returned by the specified collection's iterator.
boolean	addAll(int index, java.util.Collection<? extends E> c)
void	clear() Removes all of the values from this collection (optional operation).
boolean	contains(java.lang.Object o) Indicates if this collection contains the specified value.
boolean	containsAll(java.util.Collection<?> c) Indicates if this collection contains all of the values of the specified collection.
void	delete(FastCollection.Record record) Deletes the specified record from this collection.
E	get(int index)
FastCollection.Record	head() Returns the head record of this collection; it is the record such as head().getNext() holds the first collection value.
int	indexOf(java.lang.Object o)
boolean	isEmpty() Indicates if this collection is empty.
java.util.Iterator<E>	iterator() Returns an iterator over the elements in this collection (allocated on the stack when executed in a StackContext).
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(java.lang.Object o) Removes the first occurrence in this collection of the specified value (optional operation).
boolean	removeAll(java.util.Collection<?> c) Removes from this collection all the values that are contained in the specified collection.
void	reset() Resets the internal state of this object to its default values.
boolean	retainAll(java.util.Collection<?> c) Retains only the values in this collection that are contained in the specified collection.
E	set(int index, E element)
int	size() Returns the number of values in this collection.
java.util.List<E>	subList(int fromIndex, int toIndex)
FastCollection.Record	tail() Returns the tail record of this collection; it is the record such as tail().getPrevious() holds the last collection value.
java.lang.Object[]	toArray() Returns a new array allocated on the heap containing all of the values in this collection in proper sequence.
<T> T[]	toArray(T[] array) Fills the specified array with the values of this collection in the proper sequence.
E	valueOf(FastCollection.Record record) Returns the collection value for the specified record.

Methods inherited from class javolution.util.MutableList

shared, unmodifiable

Methods inherited from class javolution.util.FastCollection

equals, getValueComparator, hashCode, toString, toText

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SharedCollectionImpl

public SharedCollectionImpl(MutableList<E> inner)

Method Detail

add

public boolean add(E o)

Description copied from class: FastCollection

Appends the specified value to the end of this collection (optional operation).

Note: This default implementation always throws UnsupportedOperationException.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

Specified by:

add in class MutableList<E>

Parameters:

o - the value to be appended to this collection.

Returns:

true (as per the general contract of the Collection.add method).

remove

public boolean remove(java.lang.Object o)

Description copied from class: FastCollection

Removes the first occurrence in this collection of the specified value (optional operation).

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.List<E>

Specified by:

remove in class MutableList<E>

Parameters:

o - the value to be removed from this collection.

Returns:

true if this collection contained the specified value; false otherwise.

add

public void add(int index,
                E element)

Specified by:

add in interface java.util.List<E>

Specified by:

add in class MutableList<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Description copied from class: FastCollection

Appends all of the values in the specified collection to the end of this collection, in the order that they are returned by the specified collection's iterator.

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

Specified by:

addAll in class MutableList<E>

Parameters:

c - collection whose values are to be added to this collection.

Returns:

true if this collection changed as a result of the call; false otherwise.

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.List<E>

Specified by:

addAll in class MutableList<E>

clear

public void clear()

Description copied from class: FastCollection

Removes all of the values from this collection (optional operation).

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Specified by:

clear in class MutableList<E>

contains

public boolean contains(java.lang.Object o)

Description copied from class: FastCollection

Indicates if this collection contains the specified value.

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.List<E>

Specified by:

contains in class MutableList<E>

Parameters:

o - the value whose presence in this collection is to be tested.

Returns:

true if this collection contains the specified value;false otherwise.

containsAll

public boolean containsAll(java.util.Collection<?> c)

Description copied from class: FastCollection

Indicates if this collection contains all of the values of the specified collection.

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.List<E>

Overrides:

containsAll in class FastCollection<E>

Parameters:

c - collection to be checked for containment in this collection.

Returns:

true if this collection contains all of the values of the specified collection; false otherwise.

delete

public void delete(FastCollection.Record record)

Description copied from class: FastCollection

Deletes the specified record from this collection.

Implementation must ensure that removing a record from the collection does not affect in any way the records preceding the record being removed (it might affect the next records though, e.g. in a list collection, the indices of the subsequent records will change).

Specified by:

delete in class MutableList<E>

Parameters:

record - the record to be removed.

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

Specified by:

get in class MutableList<E>

head

public FastCollection.Record head()

Description copied from class: FastCollection

Returns the head record of this collection; it is the record such as head().getNext() holds the first collection value.

Specified by:

head in class MutableList<E>

Returns:

the head record.

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<E>

Specified by:

indexOf in class MutableList<E>

isEmpty

public boolean isEmpty()

Description copied from class: FastCollection

Indicates if this collection is empty.

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.List<E>

Specified by:

isEmpty in class MutableList<E>

Returns:

true if this collection contains no value; false otherwise.

iterator

public java.util.Iterator<E> iterator()

Description copied from class: FastCollection

Returns an iterator over the elements in this collection (allocated on the stack when executed in a StackContext).

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.List<E>

Specified by:

iterator in class MutableList<E>

Returns:

an iterator over this collection's elements.

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<E>

Specified by:

lastIndexOf in class MutableList<E>

listIterator

public java.util.ListIterator<E> listIterator()

Specified by:

listIterator in interface java.util.List<E>

Specified by:

listIterator in class MutableList<E>

listIterator

public java.util.ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface java.util.List<E>

Specified by:

listIterator in class MutableList<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

Specified by:

remove in class MutableList<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Description copied from class: FastCollection

Removes from this collection all the values that are contained in the specified collection.

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

Overrides:

removeAll in class FastCollection<E>

Parameters:

c - collection that defines which values will be removed from this collection.

Returns:

true if this collection changed as a result of the call; false otherwise.

reset

public void reset()

Description copied from interface: Reusable

Resets the internal state of this object to its default values.

Specified by:

reset in interface Reusable

retainAll

public boolean retainAll(java.util.Collection<?> c)

Description copied from class: FastCollection

Retains only the values in this collection that are contained in the specified collection.

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.List<E>

Overrides:

retainAll in class FastCollection<E>

Parameters:

c - collection that defines which values this set will retain.

Returns:

true if this collection changed as a result of the call; false otherwise.

set

public E set(int index,
             E element)

Specified by:

set in interface java.util.List<E>

Specified by:

set in class MutableList<E>

size

public int size()

Description copied from class: FastCollection

Returns the number of values in this collection.

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

Specified by:

size in class MutableList<E>

Returns:

the number of values.

subList

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

Specified by:

subList in interface java.util.List<E>

Specified by:

subList in class MutableList<E>

tail

public FastCollection.Record tail()

Description copied from class: FastCollection

Returns the tail record of this collection; it is the record such as tail().getPrevious() holds the last collection value.

Specified by:

tail in class MutableList<E>

Returns:

the tail record.

toArray

public java.lang.Object[] toArray()

Description copied from class: FastCollection

Returns a new array allocated on the heap containing all of the values in this collection in proper sequence.

Note: To avoid heap allocation FastCollection.toArray(Object[]) is recommended.

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class FastCollection<E>

Returns:

toArray(new Object[size()])

toArray

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

Description copied from class: FastCollection

Fills the specified array with the values of this collection in the proper sequence.

Note: Unlike standard Collection, this method does not try to resize the array using reflection (which might not be supported) if the array is too small. UnsupportedOperationException is raised if the specified array is too small for this collection.

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class FastCollection<E>

Parameters:

array - the array into which the values of this collection are to be stored.

Returns:

the specified array.

valueOf

public E valueOf(FastCollection.Record record)

Description copied from class: FastCollection

Returns the collection value for the specified record.

Specified by:

valueOf in class MutableList<E>

Parameters:

record - the record whose current value is returned.

Returns:

the current value.