net.walend.collection
Class ImmutableBag

java.lang.Object
  |
  +--net.walend.collection.ImmutableBag

All Implemented Interfaces:

Bag, java.util.Collection, HasState, net.walend.enum.Immutable, java.io.Serializable

public final class ImmutableBag

extends java.lang.Object

implements Bag, java.io.Serializable, net.walend.enum.Immutable

An implementation of the Bag interface that wraps another Bag and throws UnsupportedOperationExceptions in all the mutators.

Author:

David Walend dfw1@cornell.edu

See Also:

Serialized Form

Field Summary

private Bag

wrappedBag

Fields inherited from interface net.walend.collection.Bag

EMPTY

Constructor Summary

ImmutableBag(Bag bag)

Method Summary

boolean	add(java.lang.Object o) Ensures that this collection contains the specified element (optional operation).
boolean	addAll(java.util.Collection c) Adds all of the elements in the specified collection to this collection (optional operation).
void	clear() Removes all of the elements from this collection (optional operation).
boolean	contains(java.lang.Object o) Returns true if this collection contains the specified element.
boolean	containsAll(java.util.Collection c) Returns true if this collection contains all of the elements in the specified collection.
int	countObjects(java.lang.Object inBag) Returns the count of objects in the bag.
java.lang.Class	getPrincipleInterface() Returns the class's principle interface for state comparisons.
boolean	isEmpty() Returns true if this collection contains no elements.
java.util.Iterator	iterator() Returns an iterator over the elements in this collection.
boolean	remove(java.lang.Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(java.util.Collection c) Removes all this collection's elements that are also contained in the specified collection (optional operation).
boolean	retainAll(java.util.Collection c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
boolean	sameContentsAs(Bag bag) Returns true if this contains the same numbers of the same objects as bag.
boolean	sameStateAs(HasState victim) If two HasStates have the same internal state, return true.
int	size() Returns the number of elements in this collection.
java.lang.Object[]	toArray() Returns an array containing all of the elements in this collection.
java.lang.Object[]	toArray(java.lang.Object[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Field Detail

wrappedBag

private Bag wrappedBag

Constructor Detail

ImmutableBag

public ImmutableBag(Bag bag)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

size

public int size()

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.Collection

Returns:

the number of elements in this collection

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface java.util.Collection

Returns:

true if this collection contains no elements

contains

public boolean contains(java.lang.Object o)

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface java.util.Collection

Parameters:

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

Returns:

true if this collection contains the specified element

iterator

public java.util.Iterator iterator()

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Specified by:

iterator in interface java.util.Collection

Returns:

an Iterator over the elements in this collection

toArray

public java.lang.Object[] toArray()

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface java.util.Collection

Returns:

an array containing all of the elements in this collection

toArray

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

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

    String[] x = (String[]) v.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface java.util.Collection

Parameters:

a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this collection

Throws:

java.lang.ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

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

add

public boolean add(java.lang.Object o)

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface java.util.Collection

Parameters:

o - element whose presence in this collection is to be ensured.

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - add is not supported by this collection.

java.lang.ClassCastException - class of the specified element prevents it from being added to this collection.

java.lang.IllegalArgumentException - some aspect of this element prevents it from being added to this collection.

remove

public boolean remove(java.lang.Object o)

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

remove in interface java.util.Collection

Parameters:

o - element to be removed from this collection, if present.

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - remove is not supported by this collection.

containsAll

public boolean containsAll(java.util.Collection c)

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAll in interface java.util.Collection

Parameters:

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

Returns:

true if this collection contains all of the elements in the specified collection

Throws:

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

See Also:

contains(Object)

addAll

public boolean addAll(java.util.Collection c)

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Specified by:

addAll in interface java.util.Collection

Parameters:

c - elements to be inserted into this collection.

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if this collection does not support the addAll method.

java.lang.ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection.

java.lang.IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.

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

See Also:

add(Object)

removeAll

public boolean removeAll(java.util.Collection c)

Removes all this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAll in interface java.util.Collection

Parameters:

c - elements to be removed from this collection.

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the removeAll method is not supported by this collection.

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

See Also:

remove(Object), contains(Object)

retainAll

public boolean retainAll(java.util.Collection c)

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface java.util.Collection

Parameters:

c - elements to be retained in this collection.

Returns:

true if this collection changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the retainAll method is not supported by this Collection.

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

See Also:

remove(Object), contains(Object)

clear

public void clear()

Removes all of the elements from this collection (optional operation). This collection will be empty after this method returns unless it throws an exception.

Specified by:

clear in interface java.util.Collection

Throws:

java.lang.UnsupportedOperationException - if the clear method is not supported by this collection.

countObjects

public int countObjects(java.lang.Object inBag)

Returns the count of objects in the bag.

Specified by:

countObjects in interface Bag

sameContentsAs

public boolean sameContentsAs(Bag bag)

Returns true if this contains the same numbers of the same objects as bag.

Specified by:

sameContentsAs in interface Bag

getPrincipleInterface

public java.lang.Class getPrincipleInterface()

Returns the class's principle interface for state comparisons. If two objects have different principle interfaces, they never have the same state.

Specified by:

getPrincipleInterface in interface HasState

sameStateAs

public boolean sameStateAs(HasState victim)

If two HasStates have the same internal state, return true.

For objects with subobjects, Generally this method should only return true if the internal objects are equal. Implement a contentsHaveSameState() method to determine if the contents have the same state.

Specified by:

sameStateAs in interface HasState