javolution.util

Class MutableList<E>

java.lang.Object

javolution.util.FastCollection<E>

javolution.util.MutableList<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

FastList, FastTable, SharedCollectionImpl, UnmodifiableCollectionImpl

public abstract class MutableList<E>
extends FastCollection<E>
implements java.util.List<E>, Reusable

This class represents a skeleton for FastTable and FastList.

See Also:

Serialized Form

Nested Class Summary

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

FastCollection.Record

Constructor Summary

Constructors

Constructor and Description
MutableList()

Method Summary

Modifier and Type	Method and Description
abstract boolean	add(E o) Appends the specified value to the end of this collection (optional operation).
abstract void	add(int index, E element)
abstract 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.
abstract boolean	addAll(int index, java.util.Collection<? extends E> c)
abstract void	clear() Removes all of the values from this collection (optional operation).
abstract boolean	contains(java.lang.Object o) Indicates if this collection contains the specified value.
abstract void	delete(FastCollection.Record record) Deletes the specified record from this collection.
abstract E	get(int index)
abstract FastCollection.Record	head() Returns the head record of this collection; it is the record such as head().getNext() holds the first collection value.
abstract int	indexOf(java.lang.Object o)
abstract boolean	isEmpty() Indicates if this collection is empty.
abstract java.util.Iterator<E>	iterator() Returns an iterator over the elements in this collection (allocated on the stack when executed in a StackContext).
abstract int	lastIndexOf(java.lang.Object o)
abstract java.util.ListIterator<E>	listIterator()
abstract java.util.ListIterator<E>	listIterator(int index)
abstract E	remove(int index)
abstract boolean	remove(java.lang.Object o) Removes the first occurrence in this collection of the specified value (optional operation).
abstract E	set(int index, E element)
MutableList<E>	shared() Returns a thread-safe read-write view of this collection.
abstract int	size() Returns the number of values in this collection.
abstract java.util.List<E>	subList(int fromIndex, int toIndex)
abstract FastCollection.Record	tail() Returns the tail record of this collection; it is the record such as tail().getPrevious() holds the last collection value.
MutableList<E>	unmodifiable() Returns the unmodifiable view associated to this collection.
abstract E	valueOf(FastCollection.Record record) Returns the collection value for the specified record.

Methods inherited from class javolution.util.FastCollection

containsAll, equals, getValueComparator, hashCode, removeAll, retainAll, toArray, toArray, toString, toText

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface javolution.lang.Reusable

reset

Constructor Detail

MutableList

public MutableList()

Method Detail

unmodifiable

public MutableList<E> unmodifiable()

Description copied from class: FastCollection

Returns the unmodifiable view associated to this collection. Attempts to modify the returned collection result in an UnsupportedOperationException being thrown.

Overrides:

unmodifiable in class FastCollection<E>

Returns:

the unmodifiable view over this collection.

shared

public MutableList<E> shared()

Description copied from class: FastCollection

Returns a thread-safe read-write view of this collection.

The default implementation performs synchronization on read and write. Sub-classes may provide more efficient implementation (e.g. only synchronizing on writes modifying the internal data structure).

Having a shared collection does not mean that modifications made by onethread are automatically viewed by others thread. Which in practice is not an issue. In a well-behaved system, threads need to synchronize only at predetermined synchronization points (the fewer the better).

Overrides:

shared in class FastCollection<E>

Returns:

a thread-safe collection.

size

public abstract 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 FastCollection<E>

Returns:

the number of values.

isEmpty

public abstract 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>

Overrides:

isEmpty in class FastCollection<E>

Returns:

true if this collection contains no value; false otherwise.

contains

public abstract 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>

Overrides:

contains in class FastCollection<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.

iterator

public abstract 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>

Overrides:

iterator in class FastCollection<E>

Returns:

an iterator over this collection's elements.

add

public abstract 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>

Overrides:

add in class FastCollection<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 abstract 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>

Overrides:

remove in class FastCollection<E>

Parameters:

o - the value to be removed from this collection.

Returns:

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

addAll

public abstract 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>

Overrides:

addAll in class FastCollection<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 abstract boolean addAll(int index,
                               java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.List<E>

clear

public abstract 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>

Overrides:

clear in class FastCollection<E>

get

public abstract E get(int index)

Specified by:

get in interface java.util.List<E>

set

public abstract E set(int index,
                      E element)

Specified by:

set in interface java.util.List<E>

add

public abstract void add(int index,
                         E element)

Specified by:

add in interface java.util.List<E>

remove

public abstract E remove(int index)

Specified by:

remove in interface java.util.List<E>

indexOf

public abstract int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<E>

lastIndexOf

public abstract int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<E>

listIterator

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

Specified by:

listIterator in interface java.util.List<E>

listIterator

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

Specified by:

listIterator in interface java.util.List<E>

subList

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

Specified by:

subList in interface java.util.List<E>

head

public abstract 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 FastCollection<E>

Returns:

the head record.

tail

public abstract 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 FastCollection<E>

Returns:

the tail record.

valueOf

public abstract E valueOf(FastCollection.Record record)

Description copied from class: FastCollection

Returns the collection value for the specified record.

Specified by:

valueOf in class FastCollection<E>

Parameters:

record - the record whose current value is returned.

Returns:

the current value.

delete

public abstract 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 FastCollection<E>

Parameters:

record - the record to be removed.