com.sleepycat.collections
Class StoredKeySet
java.lang.Object
   com.sleepycat.collections.StoredContainer
com.sleepycat.collections.StoredContainer
       com.sleepycat.collections.StoredCollection
com.sleepycat.collections.StoredCollection
           com.sleepycat.collections.StoredKeySet
com.sleepycat.collections.StoredKeySet
- All Implemented Interfaces: 
- Cloneable, Iterable, Collection, Set
- Direct Known Subclasses: 
- StoredSortedKeySet
- public class StoredKeySet 
- extends StoredCollection- implements Set
The Set 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.
 
 
 
| Method Summary | 
|  boolean | add(Object key)Adds the specified key to this set if it is not already present
 (optional operation).
 | 
|  boolean | contains(Object key)Returns true if this set contains the specified key.
 | 
|  boolean | remove(Object key)Removes the specified key from this set if it is present (optional
 operation).
 | 
 
| Methods inherited from class com.sleepycat.collections.StoredCollection | 
| addAll, containsAll, equals, getIteratorBlockSize, hashCode, iterator, iterator, join, removeAll, retainAll, setIteratorBlockSize, size, storedIterator, storedIterator, toArray, toArray, toList, toString | 
 
| Methods inherited from class com.sleepycat.collections.StoredContainer | 
| areDuplicatesAllowed, areDuplicatesOrdered, areKeysRenumbered, clear, getCursorConfig, isDirtyRead, isDirtyReadAllowed, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed | 
 
 
| Methods inherited from interface java.util.Set | 
| addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray | 
 
StoredKeySet
public StoredKeySet(Database database,
                    EntryBinding keyBinding,
                    boolean writeAllowed)
- Creates a key set view of a Database.
 
- Parameters:
- database- is the Database underlying the new collection.
- keyBinding- is the binding used to translate between key buffers
 and key objects.
- writeAllowed- is true to create a read-write collection or false
 to create a read-only collection.
- Throws:
- IllegalArgumentException- if formats are not consistently
 defined or a parameter is invalid.
- RuntimeExceptionWrapper- if a- DatabaseExceptionis
 thrown.
 
add
public boolean add(Object key)
- Adds the specified key to this set if it is not already present
 (optional operation).
 When a key is added the value in the underlying data store will be
 empty.
 This method conforms to the Set.add(java.lang.Object)interface.
 
- 
- Specified by:
- addin interface- Collection
- Specified by:
- addin interface- Set
 
- 
- Throws:
- UnsupportedOperationException- if the collection is indexed, or
 if the collection is read-only.
- RuntimeExceptionWrapper- if a- DatabaseExceptionis
 thrown.
 
remove
public boolean remove(Object key)
- Removes the specified key from this set if it is present (optional
 operation).
 If duplicates are allowed, this method removes all duplicates for the
 given key.
 This method conforms to the Set.remove(java.lang.Object)interface.
 
- 
- Specified by:
- removein interface- Collection
- Specified by:
- removein interface- Set
 
- 
- Throws:
- UnsupportedOperationException- if the collection is read-only.
- RuntimeExceptionWrapper- if a- DatabaseExceptionis
 thrown.
 
contains
public boolean contains(Object key)
- Returns true if this set contains the specified key.
 This method conforms to the Set.contains(java.lang.Object)interface.
 
- 
- Specified by:
- containsin interface- Collection
- Specified by:
- containsin interface- Set
 
- 
- Throws:
- RuntimeExceptionWrapper- if a- DatabaseExceptionis
 thrown.
 
Copyright (c) 1996,2007 Oracle.  All rights reserved.