decaf::util::AbstractSet< E > Class Template Reference

This class provides a skeletal implementation of the Set interface to minimize the effort required to implement this interface. More...

#include <src/main/decaf/util/AbstractSet.h>

Inheritance diagram for decaf::util::AbstractSet< E >:

Public Member Functions
virtual	~AbstractSet ()
virtual bool	removeAll (const Collection< E > &collection)
	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. Parameters collection The Collection whose elements are to be removed from this one. Returns true if the collection changed as a result of this call. Exceptions UnsupportedOperationExceptio if this is an unmodifiable collection. NullPointerException if the Collection is a container of pointers and does not allow NULL values. This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method.Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection.
Public Member Functions inherited from decaf::util::Set< E >
virtual	~Set ()
Public Member Functions inherited from decaf::util::Collection< E >
virtual	~Collection ()
virtual bool	add (const E &value)=0
	Returns true if this collection changed as a result of the call.
virtual int	size () const =0
	Returns the number of elements in this collection.
Public Member Functions inherited from decaf::lang::Iterable< E >
virtual	~Iterable ()
virtual decaf::util::Iterator < E > *	iterator ()=0
virtual decaf::util::Iterator < E > *	iterator () const =0
Public Member Functions inherited from decaf::util::concurrent::Synchronizable
virtual	~Synchronizable ()
Public Member Functions inherited from decaf::util::AbstractCollection< E >
	AbstractCollection ()
virtual	~AbstractCollection ()
AbstractCollection< E > &	operator= (const AbstractCollection< E > &collection)
	Assignment Operator, copy element from the source collection to this collection after clearing any element stored in this collection.
virtual void	clear ()
	Removes all of the elements from this collection (optional operation).
virtual bool	contains (const E &value) const
	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 (value == NULL ? e == NULL : value == e ). Parameters value The value to check for presence in the collection. Returns true if there is at least one of the elements in the collection Exceptions NullPointerException if the Collection contains pointers and the Collection does not allow for NULL elements (optional check).
virtual bool	containsAll (const Collection< E > &collection) const
	Returns true if this collection contains all of the elements in the specified collection. Parameters collection The Collection to compare to this one. Exceptions NullPointerException if the Collection contains pointers and the Collection does not allow for NULL elements (optional check).
virtual bool	equals (const Collection< E > &collection) const
	Answers true if this Collection and the one given are the same size and if each element contained in the Collection given is equal to an element contained in this collection.
virtual void	copy (const Collection< E > &collection)
	Renders this Collection as a Copy of the given Collection.
virtual bool	isEmpty () const
	Returns true if this collection contains no elements.
virtual bool	add (const E &value DECAF_UNUSED)
virtual bool	addAll (const Collection< E > &collection)
	Adds all of the elements in the specified collection to this collection.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.) Parameters collection The Collection whose elements are added to this one. Returns true if this collection changed as a result of the call Exceptions UnsupportedOperationExceptio if this is an unmodifiable collection. NullPointerException if the Collection is a container of pointers and does not allow NULL values. IllegalArgumentException if some property of an element prevents it from being added to this collection IllegalStateException if an element cannot be added at this time due to insertion restrictions.
virtual bool	remove (const E &value)
	Removes a single instance of the specified element from the collection.More formally, removes an element e such that (value == NULL ? e == NULL : value == 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). Parameters value The reference to the element to remove from this Collection. Returns true if the collection was changed, false otherwise. Exceptions UnsupportedOperationExceptio if this is an unmodifiable collection. NullPointerException if the Collection is a container of pointers and does not allow NULL values.
virtual bool	retainAll (const Collection< E > &collection)
	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. Parameters collection The Collection whose elements are to be retained. Returns true if the collection changed as a result of this call. Exceptions UnsupportedOperationExceptio if this is an unmodifiable collection. NullPointerException if the Collection is a container of pointers and does not allow NULL values.
virtual std::vector< E >	toArray () const
	Answers an STL vector containing copies of all elements contained in this Collection.
virtual void	lock ()
	Locks the object.
virtual bool	tryLock ()
	Attempts to Lock the object, if the lock is already held by another thread than this method returns false.
virtual void	unlock ()
	Unlocks the object.
virtual void	wait ()
	Waits on a signal from this object, which is generated by a call to Notify.
virtual void	wait (long long millisecs)
	Waits on a signal from this object, which is generated by a call to Notify.
virtual void	wait (long long millisecs, int nanos)
	Waits on a signal from this object, which is generated by a call to Notify.
virtual void	notify ()
	Signals a waiter on this object that it can now wake up and continue.
virtual void	notifyAll ()
	Signals the waiters on this object that it can now wake up and continue.

Additional Inherited Members
Protected Attributes inherited from decaf::util::AbstractCollection< E >
util::concurrent::Mutex	mutex

Detailed Description

template<typename E>
class decaf::util::AbstractSet< E >

This class provides a skeletal implementation of the Set interface to minimize the effort required to implement this interface.

The process of implementing a set by extending this class is identical to that of implementing a Collection by extending AbstractCollection, except that all of the methods and constructors in subclasses of this class must obey the additional constraints imposed by the Set interface (for instance, the add method must not permit addition of multiple instances of an object to a set).

Since

1.0

Constructor & Destructor Documentation

template<typename E>

virtual decaf::util::AbstractSet< E >::~AbstractSet ( )

inlinevirtual

Member Function Documentation

template<typename E>

virtual bool decaf::util::AbstractSet< E >::removeAll ( const Collection< E > &  collection )

inlinevirtual

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.

Parameters

collection

The Collection whose elements are to be removed from this one.

Returns

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

Exceptions

UnsupportedOperationExceptio	if this is an unmodifiable collection.
NullPointerException	if the Collection is a container of pointers and does not allow NULL values.

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method.Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection.

This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

Reimplemented from decaf::util::AbstractCollection< E >.

Reimplemented in decaf::util::concurrent::CopyOnWriteArraySet< E >.

---

The documentation for this class was generated from the following file:

• src/main/decaf/util/AbstractSet.h