ptolemy.backtrack.util.java.util

Class AbstractCollection

java.lang.Object

ptolemy.backtrack.util.java.util.AbstractCollection

All Implemented Interfaces:

Rollbackable, Collection

Direct Known Subclasses:

AbstractList, AbstractSet

public abstract class AbstractCollection
extends java.lang.Object
implements Collection, Rollbackable

A basic implementation of most of the methods in the Collection interface to make it easier to create a collection. To create an unmodifiable Collection, just subclass AbstractCollection and provide implementations of the iterator() and size() methods. The Iterator returned by iterator() need only provide implementations of hasNext() and next() (that is, it may throw an UnsupportedOperationException if remove() is called). To create a modifiable Collection, you must in addition provide an implementation of the add(Object) method and the Iterator returned by iterator() must provide an implementation of remove(). Other methods should be overridden if the backing data structure allows for a more efficient implementation. The precise implementation used by AbstractCollection is documented, so that subclasses can tell which methods could be implemented more efficiently.

The programmer should provide a no-argument constructor, and one that accepts another Collection, as recommended by the Collection interface. Unfortunately, there is no way to enforce this in Java.

Since:

1.2

Author:

Original author unknown, Bryce McKinlay, Eric Blake (ebb9@email.byu.edu)

See Also:

Collection, AbstractSet, AbstractList

Status

updated to 1.4

Field Summary

Fields

Modifier and Type	Field and Description
protected Checkpoint	$CHECKPOINT
protected CheckpointRecord	$RECORD$$CHECKPOINT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCollection() The main constructor, for use by subclasses.

Method Summary

Modifier and Type	Method and Description
void	$COMMIT(long timestamp) Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.
Checkpoint	$GET$CHECKPOINT() Get the checkpoint object that monitors this rollbackable object.
void	$RESTORE(long timestamp, boolean trim) Restore a previous state to all the private fields of this rollbackable object.
java.lang.Object	$SET$CHECKPOINT(Checkpoint checkpoint) Set the checkpoint object of this rollbackable object.
boolean	add(java.lang.Object o) Add an object to the collection (optional operation).
boolean	addAll(Collection c) Add all the elements of a given collection to this collection (optional operation).
void	clear() Remove all elements from the collection (optional operation).
boolean	contains(java.lang.Object o) Test whether this collection contains a given object.
boolean	containsAll(Collection c) Tests whether this collection contains all the elements in a given collection.
boolean	isEmpty() Test whether this collection is empty.
abstract java.util.Iterator	iterator() Return an Iterator over this collection.
boolean	remove(java.lang.Object o) Remove a single instance of an object from this collection (optional operation).
boolean	removeAll(Collection c) Remove from this collection all its elements that are contained in a given collection (optional operation).
boolean	retainAll(Collection c) Remove from this collection all its elements that are not contained in a given collection (optional operation).
abstract int	size() Return the number of elements in this collection.
java.lang.Object[]	toArray() Return an array containing the elements of this collection.
java.lang.Object[]	toArray(java.lang.Object[] a) Copy the collection into a given array if it will fit, or into a dynamically created array of the same run-time type as the given array if not.
java.lang.String	toString() Creates a String representation of the Collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.backtrack.util.java.util.Collection

equals, hashCode

Field Detail

$CHECKPOINT

protected transient Checkpoint $CHECKPOINT

$RECORD$$CHECKPOINT

protected transient CheckpointRecord $RECORD$$CHECKPOINT

Constructor Detail

AbstractCollection

protected AbstractCollection()

The main constructor, for use by subclasses.

Method Detail

iterator

public abstract java.util.Iterator iterator()

Return an Iterator over this collection. The iterator must provide the hasNext and next methods and should in addition provide remove if the collection is modifiable.

Specified by:

iterator in interface Collection

Returns:

an iterator

size

public abstract int size()

Return the number of elements in this collection. If there are more than Integer.MAX_VALUE elements, return Integer.MAX_VALUE.

Specified by:

size in interface Collection

Returns:

the size

add

public boolean add(java.lang.Object o)

Add an object to the collection (optional operation). This implementation always throws an UnsupportedOperationException - it should be overridden if the collection is to be modifiable. If the collection does not accept duplicates, simply return false. Collections may specify limitations on what may be added.

Specified by:

add in interface Collection

Parameters:

o - the object to add

Returns:

true if the add operation caused the Collection to change

Throws:

java.lang.UnsupportedOperationException - if the add operation is not supported on this collection

java.lang.NullPointerException - if the collection does not support null

java.lang.ClassCastException - if the object is of the wrong type

java.lang.IllegalArgumentException - if some aspect of the object prevents it from being added

addAll

public boolean addAll(Collection c)

Add all the elements of a given collection to this collection (optional operation). This implementation obtains an Iterator over the given collection and iterates over it, adding each element with the add(Object) method (thus this method will fail with an UnsupportedOperationException if the add method does). The behavior is unspecified if the specified collection is modified during the iteration, including the special case of trying addAll(this) on a non-empty collection.

Specified by:

addAll in interface Collection

Parameters:

c - the collection to add the elements of to this collection

Returns:

true if the add operation caused the Collection to change

Throws:

java.lang.UnsupportedOperationException - if the add operation is not supported on this collection

java.lang.NullPointerException - if the specified collection is null

java.lang.ClassCastException - if the type of any element in c is not a valid type for addition.

java.lang.IllegalArgumentException - if some aspect of any element in c prevents it being added.

java.lang.NullPointerException - if any element in c is null and this collection doesn't allow null values.

See Also:

add(Object)

clear

public void clear()

Remove all elements from the collection (optional operation). This implementation obtains an iterator over the collection and calls next and remove on it repeatedly (thus this method will fail with an UnsupportedOperationException if the Iterator's remove method does) until there are no more elements to remove. Many implementations will have a faster way of doing this.

Specified by:

clear in interface Collection

Throws:

java.lang.UnsupportedOperationException - if the Iterator returned by iterator does not provide an implementation of remove

See Also:

Iterator.remove()

contains

public boolean contains(java.lang.Object o)

Test whether this collection contains a given object. That is, if the collection has an element e such that (o == null ? e == null : o.equals(e)). This implementation obtains an iterator over the collection and iterates over it, testing each element for equality with the given object. If it is equal, true is returned. Otherwise false is returned when the end of the collection is reached.

Specified by:

contains in interface Collection

Parameters:

o - the object to remove from this collection

Returns:

true if this collection contains an object equal to o

containsAll

public boolean containsAll(Collection c)

Tests whether this collection contains all the elements in a given collection. This implementation iterates over the given collection, testing whether each element is contained in this collection. If any one is not, false is returned. Otherwise true is returned.

Specified by:

containsAll in interface Collection

Parameters:

c - the collection to test against

Returns:

true if this collection contains all the elements in the given collection

Throws:

java.lang.NullPointerException - if the given collection is null

See Also:

contains(Object)

isEmpty

public boolean isEmpty()

Test whether this collection is empty. This implementation returns size() == 0.

Specified by:

isEmpty in interface Collection

Returns:

true if this collection is empty.

See Also:

size()

remove

public boolean remove(java.lang.Object o)

Remove a single instance of an object from this collection (optional operation). That is, remove one element e such that (o == null ? e == null : o.equals(e)), if such an element exists. This implementation obtains an iterator over the collection and iterates over it, testing each element for equality with the given object. If it is equal, it is removed by the iterator's remove method (thus this method will fail with an UnsupportedOperationException if the Iterator's remove method does). After the first element has been removed, true is returned; if the end of the collection is reached, false is returned.

Specified by:

remove in interface Collection

Parameters:

o - the object to remove from this collection

Returns:

true if the remove operation caused the Collection to change, or equivalently if the collection did contain o.

Throws:

java.lang.UnsupportedOperationException - if this collection's Iterator does not support the remove method

See Also:

Iterator.remove()

removeAll

public boolean removeAll(Collection c)

Remove from this collection all its elements that are contained in a given collection (optional operation). This implementation iterates over this collection, and for each element tests if it is contained in the given collection. If so, it is removed by the Iterator's remove method (thus this method will fail with an UnsupportedOperationException if the Iterator's remove method does).

Specified by:

removeAll in interface Collection

Parameters:

c - the collection to remove the elements of

Returns:

true if the remove operation caused the Collection to change

Throws:

java.lang.UnsupportedOperationException - if this collection's Iterator does not support the remove method

java.lang.NullPointerException - if the collection, c, is null.

See Also:

Iterator.remove()

retainAll

public boolean retainAll(Collection c)

Remove from this collection all its elements that are not contained in a given collection (optional operation). This implementation iterates over this collection, and for each element tests if it is contained in the given collection. If not, it is removed by the Iterator's remove method (thus this method will fail with an UnsupportedOperationException if the Iterator's remove method does).

Specified by:

retainAll in interface Collection

Parameters:

c - the collection to retain the elements of

Returns:

true if the remove operation caused the Collection to change

Throws:

java.lang.UnsupportedOperationException - if this collection's Iterator does not support the remove method

java.lang.NullPointerException - if the collection, c, is null.

See Also:

Iterator.remove()

toArray

public java.lang.Object[] toArray()

Return an array containing the elements of this collection. This implementation creates an Object array of size size() and then iterates over the collection, setting each element of the array from the value returned by the iterator. The returned array is safe, and is not backed by the collection.

Specified by:

toArray in interface Collection

Returns:

an array containing the elements of this collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Copy the collection into a given array if it will fit, or into a dynamically created array of the same run-time type as the given array if not. If there is space remaining in the array, the first element after the end of the collection is set to null (this is only useful if the collection is known to contain no null elements, however). This implementation first tests whether the given array is large enough to hold all the elements of the collection. If not, the reflection API is used to allocate a new array of the same run-time type. Next an iterator is obtained over the collection and the elements are placed in the array as they are returned by the iterator. Finally the first spare element, if any, of the array is set to null, and the created array is returned. The returned array is safe; it is not backed by the collection. Note that null may not mark the last element, if the collection allows null elements.

Specified by:

toArray in interface Collection

Parameters:

a - the array to copy into, or of the correct run-time type

Returns:

the array that was produced

Throws:

java.lang.NullPointerException - if the given array is null

java.lang.ArrayStoreException - if the type of the array precludes holding one of the elements of the Collection

toString

public java.lang.String toString()

Creates a String representation of the Collection. The string returned is of the form "[a, b, ...]" where a and b etc are the results of calling toString on the elements of the collection. This implementation obtains an Iterator over the Collection and adds each element to a StringBuffer as it is returned by the iterator. "" is inserted when the collection contains itself (only works for direct containment, not for collections inside collections).

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the Collection

$COMMIT

public void $COMMIT(long timestamp)

Description copied from interface: Rollbackable

Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.

Specified by:

$COMMIT in interface Rollbackable

Specified by:

$COMMIT in interface Collection

Parameters:

timestamp - The timestamp.

$RESTORE

public void $RESTORE(long timestamp,
                     boolean trim)

Description copied from interface: Rollbackable

Restore a previous state to all the private fields of this rollbackable object.

Specified by:

$RESTORE in interface Rollbackable

Specified by:

$RESTORE in interface Collection

Parameters:

timestamp - The timestamp taken at the time when the previous state was recorded.

trim - Whether to delete the records used for the rollback.

See Also:

Checkpoint.rollback(long, boolean)

$GET$CHECKPOINT

public final Checkpoint $GET$CHECKPOINT()

Description copied from interface: Rollbackable

Get the checkpoint object that monitors this rollbackable object.

Specified by:

$GET$CHECKPOINT in interface Rollbackable

Specified by:

$GET$CHECKPOINT in interface Collection

Returns:

The checkpoint object.

$SET$CHECKPOINT

public final java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)

Description copied from interface: Rollbackable

Set the checkpoint object of this rollbackable object. A merge operation is performed on the current checkpoint object and the new checkpoint object, so that the two checkpoint objects monitor the same set of objects when this function returns.

Specified by:

$SET$CHECKPOINT in interface Rollbackable

Specified by:

$SET$CHECKPOINT in interface Collection

Parameters:

checkpoint - The new checkpoint object.

Returns:

This rollbackable object itself.

See Also:

Checkpoint.setCheckpoint(Checkpoint)