| java.lang.Object
 com.sleepycat.collections.StoredContainer
com.sleepycat.collections.StoredCollection
com.sleepycat.collections.StoredKeySet
com.sleepycat.collections.StoredSortedKeySet
| StoredSortedKeySet | | public class StoredSortedKeySet extends StoredKeySet implements SortedSet(Code) | | The SortedSet returned by Map.keySet() and which can also be constructed
directly if a Map is not needed.
Since this collection is a set it only contains one element for each key,
even when duplicates are allowed. Key set iterators are therefore
particularly useful for enumerating the unique keys of a store or index that
allows duplicates.
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.
author:
Mark Hayes |
| Method Summary | |
| public Comparator | comparator()
Returns null since comparators are not supported. | | public Object | first()
Returns the first (lowest) element currently in this sorted set. | | public SortedSet | headSet(Object toKey)
Returns a view of the portion of this sorted set whose elements are
strictly less than toKey.
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:
toKey - is the upper bound. | | public SortedSet | headSet(Object toKey, boolean toInclusive)
Returns a view of the portion of this sorted set whose elements are
strictly less than toKey, optionally including toKey.
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:
toKey - is the upper bound.
Parameters:
toInclusive - is true to include toKey. | | public Object | last()
Returns the last (highest) element currently in this sorted set. | | public SortedSet | subSet(Object fromKey, Object toKey)
Returns a view of the portion of this sorted set whose elements range
from fromKey, inclusive, to toKey, 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:
fromKey - is the lower bound.
Parameters:
toKey - is the upper bound. | | public SortedSet | subSet(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)
Returns a view of the portion of this sorted set whose elements are
strictly greater than fromKey and strictly less than toKey,
optionally including fromKey and toKey.
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:
fromKey - is the lower bound.
Parameters:
fromInclusive - is true to include fromKey.
Parameters:
toKey - is the upper bound.
Parameters:
toInclusive - is true to include toKey. | | public SortedSet | tailSet(Object fromKey)
Returns a view of the portion of this sorted set whose elements are
greater than or equal to fromKey.
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:
fromKey - is the lower bound. | | public SortedSet | tailSet(Object fromKey, boolean fromInclusive)
Returns a view of the portion of this sorted set whose elements are
strictly greater than fromKey, optionally including fromKey.
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:
fromKey - is the lower bound.
Parameters:
fromInclusive - is true to include fromKey. |
| StoredSortedKeySet | | public StoredSortedKeySet(Database database, EntryBinding keyBinding, boolean writeAllowed)(Code) | | Creates a sorted key set view of a
Database .
Parameters:
database - is the Database underlying the new collection.
Parameters:
keyBinding - is the binding used to translate between key buffersand key objects.
Parameters:
writeAllowed - is true to create a read-write collection or falseto create a read-only collection.
throws:
IllegalArgumentException - if formats are not consistentlydefined or a parameter is invalid.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| comparator | | public Comparator comparator()(Code) | | 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.
null. |
| headSet | | public SortedSet headSet(Object toKey)(Code) | | Returns a view of the portion of this sorted set whose elements are
strictly less than toKey.
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:
toKey - is the upper bound. the subset.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| headSet | | public SortedSet headSet(Object toKey, boolean toInclusive)(Code) | | Returns a view of the portion of this sorted set whose elements are
strictly less than toKey, optionally including toKey.
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:
toKey - is the upper bound.
Parameters:
toInclusive - is true to include toKey. the subset.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| subSet | | public SortedSet subSet(Object fromKey, Object toKey)(Code) | | Returns a view of the portion of this sorted set whose elements range
from fromKey, inclusive, to toKey, 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:
fromKey - is the lower bound.
Parameters:
toKey - is the upper bound. the subset.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| subSet | | public SortedSet subSet(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)(Code) | | Returns a view of the portion of this sorted set whose elements are
strictly greater than fromKey and strictly less than toKey,
optionally including fromKey and toKey.
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:
fromKey - is the lower bound.
Parameters:
fromInclusive - is true to include fromKey.
Parameters:
toKey - is the upper bound.
Parameters:
toInclusive - is true to include toKey. the subset.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| tailSet | | public SortedSet tailSet(Object fromKey)(Code) | | Returns a view of the portion of this sorted set whose elements are
greater than or equal to fromKey.
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:
fromKey - is the lower bound. the subset.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| tailSet | | public SortedSet tailSet(Object fromKey, boolean fromInclusive)(Code) | | Returns a view of the portion of this sorted set whose elements are
strictly greater than fromKey, optionally including fromKey.
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:
fromKey - is the lower bound.
Parameters:
fromInclusive - is true to include fromKey. the subset.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| Fields inherited from com.sleepycat.collections.StoredCollection | final public static int DEFAULT_ITERATOR_BLOCK_SIZE(Code)(Java Doc)
|
|
|