activemq-cpp-3.9.5
decaf::util::concurrent::CopyOnWriteArraySet< E > Class Template Reference

Since the CopyOnWriteArraySet and the CopyOnWriteArrayList share much of the same operational semantics this class uses the CopyOnWriteArrayList for all its underlying operations. More...

#include <src/main/decaf/util/concurrent/CopyOnWriteArraySet.h>

Inheritance diagram for decaf::util::concurrent::CopyOnWriteArraySet< E >:

Public Member Functions

 CopyOnWriteArraySet ()
 
 CopyOnWriteArraySet (const Collection< E > &collection)
 
 CopyOnWriteArraySet (const E *array, int size)
 
virtual ~CopyOnWriteArraySet ()
 
virtual void copy (const Collection< E > &collection)
 Renders this Collection as a Copy of the given Collection.
 
virtual decaf::util::Iterator< E > * iterator ()
 
virtual decaf::util::Iterator< E > * iterator () const
 
virtual int size () const
 Returns the number of elements in this collection.
 
virtual bool isEmpty () const
 
virtual bool add (const E &value)
 Returns true if this collection changed as a result of the call.
 
virtual bool addAll (const Collection< E > &collection)
 Adds all of the elements in the specified collection to 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.
 
virtual bool containsAll (const Collection< E > &collection) const
 Returns true if this collection contains all of the elements in the specified collection.
 
virtual bool remove (const E &value)
 Removes a single instance of the specified element from the collection.
 
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
collectionThe Collection whose elements are to be removed from this one.
Returns
true if the collection changed as a result of this call.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
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.
 
virtual bool retainAll (const Collection< E > &collection)
 Retains only the elements in this collection that are contained in the specified collection (optional operation).
 
virtual std::vector< E > toArray () const
 Returns an array containing all of the elements in this collection.
 
virtual bool equals (const Collection< E > &collection) const
 Compares the passed collection to this one, if they contain the same elements, i.e.
 
- Public Member Functions inherited from decaf::util::AbstractSet< E >
 AbstractSet ()
 
virtual ~AbstractSet ()
 
- Public Member Functions inherited from decaf::util::Set< E >
virtual ~Set ()
 
- Public Member Functions inherited from decaf::util::Collection< E >
virtual ~Collection ()
 
- Public Member Functions inherited from decaf::lang::Iterable< E >
virtual ~Iterable ()
 
- Public Member Functions inherited from decaf::util::concurrent::Synchronizable
virtual ~Synchronizable ()
 
- Public Member Functions inherited from decaf::util::AbstractCollection< E >
 AbstractCollection ()
 
 AbstractCollection (const AbstractCollection &other)
 Copy Constructor, copy element from the source collection to this collection after clearing any element stored in this collection.
 
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 bool add (const E &value DECAF_UNUSED)
 
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::concurrent::CopyOnWriteArraySet< E >

Since the CopyOnWriteArraySet and the CopyOnWriteArrayList share much of the same operational semantics this class uses the CopyOnWriteArrayList for all its underlying operations.

This collection is best used in applications where the Set size is usually small and write operations are minimal as they result in a copy of the underlying array being created. Reads are generally fast and the iterators provided by this collection do not block as they operate on a snapshot of the data taken at the time of their creation.

Since
1.0

Constructor & Destructor Documentation

◆ CopyOnWriteArraySet() [1/3]

template<typename E>
decaf::util::concurrent::CopyOnWriteArraySet< E >::CopyOnWriteArraySet ( )
inline

◆ CopyOnWriteArraySet() [2/3]

template<typename E>
decaf::util::concurrent::CopyOnWriteArraySet< E >::CopyOnWriteArraySet ( const Collection< E > & collection)
inline

◆ CopyOnWriteArraySet() [3/3]

template<typename E>
decaf::util::concurrent::CopyOnWriteArraySet< E >::CopyOnWriteArraySet ( const E * array,
int size )
inline

◆ ~CopyOnWriteArraySet()

template<typename E>
virtual decaf::util::concurrent::CopyOnWriteArraySet< E >::~CopyOnWriteArraySet ( )
inlinevirtual

Member Function Documentation

◆ add()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::add ( const E & value)
inlinevirtual

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.

For non-pointer values, i.e. class instances or string's the object will be copied into the collection, thus the object must support being copied, must not hide the copy constructor and assignment operator.

Parameters
valueThe reference to the element to add to this Collection.
Returns
true if the element was added to this Collection.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of the element prevents it from being added to this collection
IllegalStateExceptionif the element cannot be added at this time due to insertion restrictions.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::addIfAbsent().

◆ addAll()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::addAll ( const Collection< E > & collection)
inlinevirtual

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
collectionThe Collection whose elements are added to this one.
Returns
true if this collection changed as a result of the call
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of an element prevents it from being added to this collection
IllegalStateExceptionif an element cannot be added at this time due to insertion restrictions.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::addAllAbsent().

◆ clear()

template<typename E>
virtual void decaf::util::concurrent::CopyOnWriteArraySet< E >::clear ( )
inlinevirtual

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

This collection will be empty after this method returns unless it throws an exception.

Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::clear().

◆ contains()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::contains ( const E & value) const
inlinevirtual

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
valueThe value to check for presence in the collection.
Returns
true if there is at least one of the elements in the collection
Exceptions
NullPointerExceptionif the Collection contains pointers and the Collection does not allow for NULL elements (optional check).

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::contains().

◆ containsAll()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::containsAll ( const Collection< E > & collection) const
inlinevirtual

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

Parameters
collectionThe Collection to compare to this one.
Exceptions
NullPointerExceptionif the Collection contains pointers and the Collection does not allow for NULL elements (optional check).

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::containsAll().

◆ copy()

template<typename E>
virtual void decaf::util::concurrent::CopyOnWriteArraySet< E >::copy ( const Collection< E > & collection)
inlinevirtual

Renders this Collection as a Copy of the given Collection.

Parameters
collectionThe collection to mirror.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
IllegalStateExceptionif the elements cannot be added at this time due to insertion restrictions.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::copy().

Referenced by CopyOnWriteArraySet().

◆ equals()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::equals ( const Collection< E > & value) const
inlinevirtual

Compares the passed collection to this one, if they contain the same elements, i.e.

all their elements are equivalent, then it returns true.

Returns
true if the Collections contain the same elements.

Implements decaf::util::Collection< E >.

References decaf::lang::Iterable< E >::iterator(), NULL, decaf::util::Collection< E >::size(), and size().

◆ isEmpty()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::isEmpty ( ) const
inlinevirtual
Returns
true if this collection contains no elements.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::isEmpty().

◆ iterator() [1/2]

template<typename E>
virtual decaf::util::Iterator< E > * decaf::util::concurrent::CopyOnWriteArraySet< E >::iterator ( )
inlinevirtual
Returns
an iterator over a set of elements of type T.

Implements decaf::lang::Iterable< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::iterator().

◆ iterator() [2/2]

template<typename E>
virtual decaf::util::Iterator< E > * decaf::util::concurrent::CopyOnWriteArraySet< E >::iterator ( ) const
inlinevirtual

◆ remove()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::remove ( const E & value)
inlinevirtual

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
valueThe reference to the element to remove from this Collection.
Returns
true if the collection was changed, false otherwise.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::remove().

◆ removeAll()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< 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
collectionThe Collection whose elements are to be removed from this one.
Returns
true if the collection changed as a result of this call.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
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.

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::AbstractSet< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::removeAll().

◆ retainAll()

template<typename E>
virtual bool decaf::util::concurrent::CopyOnWriteArraySet< E >::retainAll ( const Collection< E > & collection)
inlinevirtual

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
collectionThe Collection whose elements are to be retained.
Returns
true if the collection changed as a result of this call.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::retainAll().

◆ size()

template<typename E>
virtual int decaf::util::concurrent::CopyOnWriteArraySet< E >::size ( ) const
inlinevirtual

Returns the number of elements in this collection.

If this collection contains more than Integer::MAX_VALUE elements, returns Integer::MAX_VALUE.

Returns
the number of elements in this collection

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::size().

Referenced by CopyOnWriteArraySet(), and equals().

◆ toArray()

template<typename E>
virtual std::vector< E > decaf::util::concurrent::CopyOnWriteArraySet< E >::toArray ( ) const
inlinevirtual

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.

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

Returns
an array of the elements in this collection in the form of an STL vector.

Implements decaf::util::Collection< E >.

References decaf::util::concurrent::CopyOnWriteArrayList< E >::toArray().


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