decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet Class Reference
#include <src/main/decaf/util/HashMap.h>
Public Member Functions | ||||||||||
| HashMapKeySet (HashMap *parent) | ||||||||||
| virtual | ~HashMapKeySet () | |||||||||
| virtual bool | contains (const K &key) 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 ).
| ||||||||||
| 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.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).
| ||||||||||
| virtual Iterator< K > * | iterator () | |||||||||
| virtual Iterator< K > * | iterator () const | |||||||||
template<typename K, typename V, typename HASHCODE = HashCode<K>>
class decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet
Constructor & Destructor Documentation
| decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::HashMapKeySet | ( | HashMap * | parent | ) | [inline] |
| virtual decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::~HashMapKeySet | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual void decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::clear | ( | ) | [inline, virtual] |
Removes all of the elements from this collection (optional operation).
The collection will be empty after this method returns.
This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.
Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.
- Exceptions:
-
UnsupportedOperationException if the clear operation is not supported by this collection
Reimplemented from decaf::util::AbstractCollection< K >.
References decaf::util::HashMap< K, V, HASHCODE >::clear().
| virtual bool decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::contains | ( | const K & | value | ) | const [inline, virtual] |
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).
This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
Reimplemented from decaf::util::AbstractCollection< K >.
References decaf::util::HashMap< K, V, HASHCODE >::containsKey().
| virtual Iterator<K>* decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::iterator | ( | ) | const [inline, virtual] |
Implements decaf::lang::Iterable< K >.
| virtual Iterator<K>* decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::iterator | ( | ) | [inline, virtual] |
- Returns:
- an iterator over a set of elements of type T.
Implements decaf::lang::Iterable< K >.
| virtual bool decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::remove | ( | const K & | value | ) | [inline, virtual] |
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.
This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.
Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.
Reimplemented from decaf::util::AbstractCollection< K >.
References NULL, and decaf::util::HashMap< K, V, HASHCODE >::removeEntry().
| virtual int decaf::util::HashMap< K, V, HASHCODE >::HashMapKeySet::size | ( | ) | const [inline, virtual] |
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:
- src/main/decaf/util/HashMap.h
