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

Set template that wraps around a std::set to provide a more user-friendly interface and to provide common functions that do not exist in std::set. More...

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

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

Public Member Functions

 StlSet ()
 Default constructor - does nothing.
 
 StlSet (const StlSet &source)
 Copy constructor - copies the content of the given set into this one.
 
 StlSet (const Collection< E > &source)
 Copy constructor - copies the content of the given set into this one.
 
virtual ~StlSet ()
 
Iterator< E > * iterator ()
 
Returns
an iterator over a set of elements of type T.

 
Iterator< E > * iterator () const
 
virtual bool equals (const Collection< E > &collection) const
 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.

 
virtual void copy (const Collection< E > &collection)
 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.

 
virtual 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.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.

 
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
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).

 
virtual bool isEmpty () const
 
virtual int size () const
 
virtual bool add (const E &value)
 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.

 
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
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.

 
- Public Member Functions inherited from decaf::util::AbstractSet< E >
 AbstractSet ()
 
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
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.

 
- 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 containsAll (const Collection< E > &collection) const
 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).

 
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
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.

 
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
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.

 
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::StlSet< E >

Set template that wraps around a std::set to provide a more user-friendly interface and to provide common functions that do not exist in std::set.

Constructor & Destructor Documentation

◆ StlSet() [1/3]

template<typename E>
decaf::util::StlSet< E >::StlSet ( )
inline

Default constructor - does nothing.

References decaf::util::AbstractSet< E >::AbstractSet().

Referenced by copy(), equals(), and StlSet().

◆ StlSet() [2/3]

template<typename E>
decaf::util::StlSet< E >::StlSet ( const StlSet< E > & source)
inline

Copy constructor - copies the content of the given set into this one.

Parameters
sourceThe source set.

References decaf::util::AbstractSet< E >::AbstractSet(), copy(), and StlSet().

◆ StlSet() [3/3]

template<typename E>
decaf::util::StlSet< E >::StlSet ( const Collection< E > & source)
inline

Copy constructor - copies the content of the given set into this one.

Parameters
sourceThe source set.

References decaf::util::AbstractSet< E >::AbstractSet(), and decaf::util::AbstractCollection< E >::copy().

◆ ~StlSet()

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

Member Function Documentation

◆ add()

template<typename E>
virtual bool decaf::util::StlSet< 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 >.

◆ clear()

template<typename E>
virtual void decaf::util::StlSet< 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 >.

◆ contains()

template<typename E>
virtual bool decaf::util::StlSet< 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 >.

◆ copy()

template<typename E>
virtual void decaf::util::StlSet< 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::AbstractCollection< E >::copy(), NULL, and StlSet().

Referenced by StlSet().

◆ equals()

template<typename E>
virtual bool decaf::util::StlSet< E >::equals ( const Collection< E > & collection) 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::util::AbstractCollection< E >::equals(), NULL, and StlSet().

◆ isEmpty()

template<typename E>
virtual bool decaf::util::StlSet< E >::isEmpty ( ) const
inlinevirtual
Returns
if the set contains any element or not, TRUE or FALSE

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

◆ iterator() [1/2]

template<typename E>
Iterator< E > * decaf::util::StlSet< E >::iterator ( )
inlinevirtual

Returns
an iterator over a set of elements of type T.

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

◆ iterator() [2/2]

template<typename E>
Iterator< E > * decaf::util::StlSet< E >::iterator ( ) const
inlinevirtual

◆ remove()

template<typename E>
virtual bool decaf::util::StlSet< 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 >.

◆ size()

template<typename E>
virtual int decaf::util::StlSet< E >::size ( ) const
inlinevirtual
Returns
The number of elements in this set.

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


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