com.sleepycat.collections

Class StoredSortedEntrySet

public class StoredSortedEntrySet extends StoredEntrySet implements SortedSet

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 StoredSortedEntrySet and StoredSortedEntrySet 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 method does.

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.

Method Summary
Comparatorcomparator()
Returns null since comparators are not supported.
Objectfirst()
Returns the first (lowest) element currently in this sorted set.
SortedSetheadSet(Object toMapEntry)
Returns a view of the portion of this sorted set whose elements are strictly less than toMapEntry.
SortedSetheadSet(Object toMapEntry, boolean toInclusive)
Returns a view of the portion of this sorted set whose elements are strictly less than toMapEntry, optionally including toMapEntry.
Objectlast()
Returns the last (highest) element currently in this sorted set.
SortedSetsubSet(Object fromMapEntry, Object toMapEntry)
Returns a view of the portion of this sorted set whose elements range from fromMapEntry, inclusive, to toMapEntry, exclusive.
SortedSetsubSet(Object fromMapEntry, boolean fromInclusive, Object toMapEntry, boolean toInclusive)
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.
SortedSettailSet(Object fromMapEntry)
Returns a view of the portion of this sorted set whose elements are greater than or equal to fromMapEntry.
SortedSettailSet(Object fromMapEntry, boolean fromInclusive)
Returns a view of the portion of this sorted set whose elements are strictly greater than fromMapEntry, optionally including fromMapEntry.

Method Detail

comparator

public Comparator comparator()
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.

first

public Object first()
Returns the first (lowest) element currently in this sorted set. This method conforms to the SortedSet#first interface.

Returns: the first element.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

headSet

public SortedSet headSet(Object toMapEntry)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

headSet

public SortedSet headSet(Object toMapEntry, boolean toInclusive)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

last

public Object last()
Returns the last (highest) element currently in this sorted set. This method conforms to the SortedSet#last interface.

Returns: the last element.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

subSet

public SortedSet subSet(Object fromMapEntry, Object toMapEntry)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

subSet

public SortedSet subSet(Object fromMapEntry, boolean fromInclusive, Object toMapEntry, boolean toInclusive)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

tailSet

public SortedSet tailSet(Object fromMapEntry)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

tailSet

public SortedSet tailSet(Object fromMapEntry, boolean fromInclusive)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.