com::sleepycat::collections::StoredSortedEntrySet Class Reference

Inheritance diagram for com::sleepycat::collections::StoredSortedEntrySet:

Public Member Functions
Comparator	comparator ()
Object	first ()
Object	last ()
SortedSet	headSet (Object toMapEntry)
SortedSet	headSet (Object toMapEntry, boolean toInclusive)
SortedSet	tailSet (Object fromMapEntry)
SortedSet	tailSet (Object fromMapEntry, boolean fromInclusive)
SortedSet	subSet (Object fromMapEntry, Object toMapEntry)
SortedSet	subSet (Object fromMapEntry, boolean fromInclusive, Object toMapEntry, boolean toInclusive)

---

Detailed Description

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

In addition to the standard SortedSet methods, this class provides the following methods for stored sorted sets only. Note that the use of these methods is not compatible with the standard Java collections interface.

• headSet(Object, boolean)
• tailSet(Object, boolean)
• subSet(Object, boolean, Object, boolean)

Author:

Mark Hayes

Definition at line 47 of file StoredSortedEntrySet.java.

---

Member Function Documentation

Comparator com::sleepycat::collections::StoredSortedEntrySet::comparator (   )  [inline]

Returns null since comparators are not supported. The natural ordering of a stored collection is data byte order, whether the data classes implement the java.lang.Comparable interface or not. This method does not conform to the SortedSet#comparator interface. Returns: null. Definition at line 63 of file StoredSortedEntrySet.java.

Object com::sleepycat::collections::StoredSortedEntrySet::first (   )  [inline]

Returns the first (lowest) element currently in this sorted set. This method conforms to the SortedSet#first interface. Returns: the first element. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 77 of file StoredSortedEntrySet.java.

SortedSet com::sleepycat::collections::StoredSortedEntrySet::headSet (  Object  toMapEntry, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly less than toMapEntry, optionally including toMapEntry. This method does not exist in the standard SortedSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: toMapEntry  is the upper bound. toInclusive  is true to include toMapEntry. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 133 of file StoredSortedEntrySet.java. References subSet().

SortedSet com::sleepycat::collections::StoredSortedEntrySet::headSet (  Object  toMapEntry  )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly less than toMapEntry. This method conforms to the SortedSet#headSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: toMapEntry  the upper bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 111 of file StoredSortedEntrySet.java. References subSet().

Object com::sleepycat::collections::StoredSortedEntrySet::last (   )  [inline]

Returns the last (highest) element currently in this sorted set. This method conforms to the SortedSet#last interface. Returns: the last element. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 91 of file StoredSortedEntrySet.java.

SortedSet com::sleepycat::collections::StoredSortedEntrySet::subSet (  Object  fromMapEntry, boolean  fromInclusive, Object  toMapEntry, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly greater than fromMapEntry and strictly less than toMapEntry, optionally including fromMapEntry and toMapEntry. This method does not exist in the standard SortedSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromMapEntry  is the lower bound. fromInclusive  is true to include fromMapEntry. toMapEntry  is the upper bound. toInclusive  is true to include toMapEntry. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 224 of file StoredSortedEntrySet.java. References com::sleepycat::collections::DataView::subView().

SortedSet com::sleepycat::collections::StoredSortedEntrySet::subSet (  Object  fromMapEntry, Object  toMapEntry )  [inline]

Returns a view of the portion of this sorted set whose elements range from fromMapEntry, inclusive, to toMapEntry, exclusive. This method conforms to the SortedSet#subSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromMapEntry  is the lower bound. toMapEntry  is the upper bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 197 of file StoredSortedEntrySet.java. Referenced by headSet(), and tailSet().

SortedSet com::sleepycat::collections::StoredSortedEntrySet::tailSet (  Object  fromMapEntry, boolean  fromInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly greater than fromMapEntry, optionally including fromMapEntry. This method does not exist in the standard SortedSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromMapEntry  is the lower bound. fromInclusive  is true to include fromMapEntry. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 175 of file StoredSortedEntrySet.java. References subSet().

SortedSet com::sleepycat::collections::StoredSortedEntrySet::tailSet (  Object  fromMapEntry  )  [inline]

Returns a view of the portion of this sorted set whose elements are greater than or equal to fromMapEntry. This method conforms to the SortedSet#tailSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromMapEntry  is the lower bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 153 of file StoredSortedEntrySet.java. References subSet().

---

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

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

---