com.sleepycat.collections
Class StoredEntrySet<K,V>
java.lang.Object
com.sleepycat.collections.StoredContainer
com.sleepycat.collections.StoredCollection<Map.Entry<K,V>>
com.sleepycat.collections.StoredEntrySet<K,V>
- All Implemented Interfaces:
- Cloneable, Iterable<Map.Entry<K,V>>, Collection<Map.Entry<K,V>>, Set<Map.Entry<K,V>>
- Direct Known Subclasses:
- StoredSortedEntrySet
public class StoredEntrySet<K,V>
- extends StoredCollection<Map.Entry<K,V>>
- implements Set<Map.Entry<K,V>>
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(java.util.Map.Entry)
and StoredCollection.addAll(java.util.Collection extends E>)
methods.
The Map.Entry.setValue(V)
method of the Map.Entry objects
that are returned by this class and its iterators behaves just as the StoredIterator.set(E)
method does.
- Author:
- Mark Hayes
Methods inherited from class com.sleepycat.collections.StoredCollection |
add, addAll, blockIterator, checkIterAddAllowed, containsAll, equals, getFirstOrLast, getIndexOffset, getIteratorBlockSize, hashCode, iterateDuplicates, iterator, iterator, join, makeIteratorData, removeAll, retainAll, setIteratorBlockSize, size, storedIterator, storedIterator, toArray, toArray, toList |
Methods inherited from class com.sleepycat.collections.StoredContainer |
areDuplicatesAllowed, areDuplicatesOrdered, areKeyRangesAllowed, areKeysRenumbered, beginAutoCommit, clear, closeCursor, commitAutoCommit, configuredClone, containsKey, containsValue, convertException, getCursorConfig, getValue, handleException, initAfterClone, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed, putKeyValue, removeKey, removeValue, storedOrExternalIterator |
Methods inherited from interface java.util.Set |
addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray |
StoredEntrySet
StoredEntrySet(DataView mapView)
add
public boolean add(Map.Entry<K,V> mapEntry)
- Adds the specified element to this set if it is not already present
(optional operation).
This method conforms to the
Set.add(E)
interface.
- Specified by:
add
in interface Collection<Map.Entry<K,V>>
- Specified by:
add
in interface Set<Map.Entry<K,V>>
- Parameters:
mapEntry
- must be a Map.Entry
instance.
- Returns:
- true if the key-value pair was added to the set (and was not
previously present).
- Throws:
OperationFailureException
- if one of the Write
Operation Failures occurs.
EnvironmentFailureException
- if an unexpected, internal or
environment-wide failure occurs.
UnsupportedOperationException
- if the collection is read-only.
ClassCastException
- if the mapEntry is not a Map.Entry
instance.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C edition).
remove
public boolean remove(Object mapEntry)
- Removes the specified element from this set if it is present (optional
operation).
This method conforms to the
Set.remove(java.lang.Object)
interface.
- Specified by:
remove
in interface Collection<Map.Entry<K,V>>
- Specified by:
remove
in interface Set<Map.Entry<K,V>>
- Parameters:
mapEntry
- is a 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
Map.Entry
instance or is not
present in the set.
- Throws:
OperationFailureException
- if one of the Write
Operation Failures occurs.
EnvironmentFailureException
- if an unexpected, internal or
environment-wide failure occurs.
UnsupportedOperationException
- if the collection is read-only.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C edition).
contains
public boolean contains(Object mapEntry)
- Returns true if this set contains the specified element.
This method conforms to the
Set.contains(java.lang.Object)
interface.
- Specified by:
contains
in interface Collection<Map.Entry<K,V>>
- Specified by:
contains
in interface Set<Map.Entry<K,V>>
- Parameters:
mapEntry
- is a 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
Map.Entry
instance or is not
present in the set.
- Throws:
OperationFailureException
- if one of the Read Operation
Failures occurs.
EnvironmentFailureException
- if an unexpected, internal or
environment-wide failure occurs.
RuntimeExceptionWrapper
- if a checked exception is thrown,
including a DatabaseException
on BDB (C edition).
toString
public String toString()
- Description copied from class:
StoredCollection
- Converts the collection to a string representation for debugging.
WARNING: The returned string may be very large.
- Overrides:
toString
in class StoredCollection<Map.Entry<K,V>>
- Returns:
- the string representation.
makeIteratorData
Map.Entry<K,V> makeIteratorData(BaseIterator iterator,
DatabaseEntry keyEntry,
DatabaseEntry priKeyEntry,
DatabaseEntry valueEntry)
- Specified by:
makeIteratorData
in class StoredCollection<Map.Entry<K,V>>
hasValues
boolean hasValues()
- Specified by:
hasValues
in class StoredCollection<Map.Entry<K,V>>
Copyright (c) 2004-2012 Oracle. All rights reserved.