activemq-cpp-3.9.5
decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet Class Reference

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

Inheritance diagram for decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet:

Public Member Functions

 HashMapKeySet (HashMap *parent)
 
virtual ~HashMapKeySet ()
 
virtual bool contains (const K &key) const
 Returns true if this collection contains the specified element.
 
virtual int size () const
 Returns the number of elements in this collection.
 
virtual void clear ()
 Removes all of the elements from this collection (optional operation).
 
virtual bool remove (const K &key)
 Removes a single instance of the specified element from the collection.
 
virtual Iterator< K > * iterator ()
 
virtual Iterator< K > * iterator () const
 
- Public Member Functions inherited from decaf::util::AbstractSet< K >
 AbstractSet ()
 
virtual ~AbstractSet ()
 
virtual bool removeAll (const Collection< K > &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< K >
virtual ~Set ()
 
- Public Member Functions inherited from decaf::util::Collection< K >
virtual ~Collection ()
 
virtual bool add (const K &value)=0
 Returns true if this collection changed as a result of the call.
 
- Public Member Functions inherited from decaf::lang::Iterable< K >
virtual ~Iterable ()
 
- Public Member Functions inherited from decaf::util::concurrent::Synchronizable
virtual ~Synchronizable ()
 
- Public Member Functions inherited from decaf::util::AbstractCollection< K >
 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< K > & operator= (const AbstractCollection< K > &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< K > &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 equals (const Collection< K > &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< K > &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 K &value DECAF_UNUSED)
 
virtual bool addAll (const Collection< K > &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< K > &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< K > 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< K >
util::concurrent::Mutex mutex
 

Constructor & Destructor Documentation

◆ HashMapKeySet()

template<typename K, typename V, typename HASHCODE = HashCode<K>>
decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::HashMapKeySet ( HashMap * parent)
inline

◆ ~HashMapKeySet()

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::~HashMapKeySet ( )
inlinevirtual

Member Function Documentation

◆ clear()

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual void decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::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< K >.

References decaf::util::HashMap< K, V, HASHCODE >::clear().

◆ contains()

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual bool decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::contains ( const K & 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< K >.

References decaf::util::HashMap< K, V, HASHCODE >::containsKey().

◆ iterator() [1/2]

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual Iterator< K > * decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::iterator ( )
inlinevirtual
Returns
an iterator over a set of elements of type T.

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

◆ iterator() [2/2]

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual Iterator< K > * decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::iterator ( ) const
inlinevirtual

◆ remove()

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual bool decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::remove ( const K & 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< K >.

References NULL, and decaf::util::HashMap< K, V, HASHCODE >::removeEntry().

◆ size()

template<typename K, typename V, typename HASHCODE = HashCode<K>>
virtual int decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::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< K >.

References decaf::util::HashMap< K, V, HASHCODE >::size().


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