com::sleepycat::collections::StoredEntrySet Class Reference

Inheritance diagram for com::sleepycat::collections::StoredEntrySet:

Public Member Functions
boolean	add (Object mapEntry)
boolean	remove (Object mapEntry)
boolean	contains (Object mapEntry)
String	toString ()

---

Detailed Description

The Set returned by Map.entrySet(). This class may not be instantiated directly. Contrary to what is stated by Map#entrySet this class does support the add and addAll methods.

The java.util.Map.Entry#setValue method of the Map.Entry objects that are returned by this class and its iterators behaves just as the StoredIterator#set method does.

Note that this class does not conform to the standard Java collections interface in the following ways:

• The size method always throws UnsupportedOperationException because, for performance reasons, databases do not maintain their total record count.
• All iterators must be explicitly closed using StoredIterator#close() or StoredIterator#close(java.util.Iterator) to release the underlying database cursor resources.

Author:

Mark Hayes

Definition at line 41 of file StoredEntrySet.java.

---

Member Function Documentation

boolean com::sleepycat::collections::StoredEntrySet::add (  Object  mapEntry  )  [inline]

Adds the specified element to this set if it is not already present (optional operation). This method conforms to the Set#add interface. Parameters: mapEntry  must be a java.util.Map.Entry instance. Returns: true if the key-value pair was added to the set (and was not previously present). Exceptions: UnsupportedOperationException  if the collection is read-only. ClassCastException  if the mapEntry is not a java.util.Map.Entry instance. RuntimeExceptionWrapper  if a DatabaseException is thrown. Definition at line 65 of file StoredEntrySet.java.

boolean com::sleepycat::collections::StoredEntrySet::contains (  Object  mapEntry  )  [inline]

Returns true if this set contains the specified element. This method conforms to the Set#contains interface. Parameters: mapEntry  is a java.util.Map.Entry instance to be checked. Returns: true if the key-value pair is present in the set, or false if the mapEntry is not a java.util.Map.Entry instance or is not present in the set. Exceptions: RuntimeExceptionWrapper  if a DatabaseException is thrown. Definition at line 122 of file StoredEntrySet.java. References com::sleepycat::collections::DataCursor::getSearchBoth().

boolean com::sleepycat::collections::StoredEntrySet::remove (  Object  mapEntry  )  [inline]

Removes the specified element from this set if it is present (optional operation). This method conforms to the Set#remove interface. Parameters: mapEntry  is a java.util.Map.Entry instance to be removed. Returns: true if the key-value pair was removed from the set, or false if the mapEntry is not a java.util.Map.Entry instance or is not present in the set. Exceptions: UnsupportedOperationException  if the collection is read-only. RuntimeExceptionWrapper  if a DatabaseException is thrown. Definition at line 86 of file StoredEntrySet.java. References com::sleepycat::collections::DataCursor::delete(), and com::sleepycat::collections::DataCursor::getSearchBoth().

String com::sleepycat::collections::StoredEntrySet::toString (   )  [inline]

Converts the collection to a string representation for debugging. WARNING: The returned string may be very large. Returns: the string representation. Exceptions: RuntimeExceptionWrapper  if a DatabaseException is thrown. Reimplemented from com::sleepycat::collections::StoredCollection. Definition at line 142 of file StoredEntrySet.java. References com::sleepycat::collections::StoredCollection::iterator().

---

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

• /home/huihoo/src/db/db-4.4.16/java/src/com/sleepycat/collections/StoredEntrySet.java

---