-StoredMap (Oracle - Berkeley DB Java API) -

- - - - - - -

-Nested Class Summary

- - - - - - - - -

Nested classes/interfaces inherited from interface java.util.Map
`Map.Entry<K,V>`

- - +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from interface java.util.Map
  +java.util.Map.Entry<K,V>
+

- - - - - - - - - - - - - - - - - - -

-Constructor Summary
`StoredMap(Database database, - EntryBinding<K> keyBinding, - EntityBinding<V> valueEntityBinding, - boolean writeAllowed)` - - - Creates a map entity view of a `Database`.
`StoredMap(Database database, - EntryBinding<K> keyBinding, - EntityBinding<V> valueEntityBinding, - PrimaryKeyAssigner keyAssigner)` - - - Creates a map entity view of a `Database` with a `PrimaryKeyAssigner`.
`StoredMap(Database database, - EntryBinding<K> keyBinding, - EntryBinding<V> valueBinding, - boolean writeAllowed)` - - - Creates a map view of a `Database`.
`StoredMap(Database database, - EntryBinding<K> keyBinding, - EntryBinding<V> valueBinding, - PrimaryKeyAssigner keyAssigner)` - - - Creates a map view of a `Database` with a `PrimaryKeyAssigner`.

- +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + + + + +

Constructors
Constructor and Description
`StoredMap(Database database, + EntryBinding<K> keyBinding, + EntityBinding<V> valueEntityBinding, + boolean writeAllowed)` + Creates a map entity view of a `Database`. +
`StoredMap(Database database, + EntryBinding<K> keyBinding, + EntityBinding<V> valueEntityBinding, + PrimaryKeyAssigner keyAssigner)` + Creates a map entity view of a `Database` with a `PrimaryKeyAssigner`. +
`StoredMap(Database database, + EntryBinding<K> keyBinding, + EntryBinding<V> valueBinding, + boolean writeAllowed)` + Creates a map view of a `Database`. +
`StoredMap(Database database, + EntryBinding<K> keyBinding, + EntryBinding<V> valueBinding, + PrimaryKeyAssigner keyAssigner)` + Creates a map view of a `Database` with a `PrimaryKeyAssigner`. +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Method Summary

- K append(V value) - -
- Appends a given value returning the newly assigned key.

- boolean containsKey(Object key) - -
- Returns true if this map contains the specified key.

- boolean containsValue(Object value) - -
- Returns true if this map contains the specified value.

- Collection<V> duplicates(K key) - -
- Returns a new collection containing the values mapped to the given key - in this map.


-
-
-
-
-
-<PK> Map<PK,V>
-

duplicatesMap(K secondaryKey,
-              EntryBinding primaryKeyBinding)

- -
- Returns a new map from primary key to value for the subset of records - having a given secondary key (duplicates).

- Set<Map.Entry<K,V>> entrySet() - -
- Returns a set view of the mappings contained in this map.

- boolean equals(Object other) - -
- Compares the specified object with this map for equality.

- V get(Object key) - -
- Returns the value to which this map maps the specified key.

- int hashCode() - -
-

- Set<K> keySet() - -
- Returns a set view of the keys contained in this map.

- V put(K key, - V value) - -
- Associates the specified value with the specified key in this map - (optional operation).

- void putAll(Map<? extends K,? extends V> map) - -
- Copies all of the mappings from the specified map to this map (optional - operation).

- V putIfAbsent(K key, - V value) - -
- If the specified key is not already associated with a value, associate - it with the given value.

- V remove(Object key) - -
- Removes the mapping for this key from this map if present (optional - operation).

- boolean remove(Object key, - Object value) - -
- Remove entry for key only if currently mapped to given value.

- V replace(K key, - V value) - -
- Replace entry for key only if currently mapped to some value.

- boolean replace(K key, - V oldValue, - V newValue) - -
- Replace entry for key only if currently mapped to given value.

- int size() - -
- Returns a non-transactional count of the records in the collection or - map.

- String toString() - -
- Converts the map to a string representation for debugging.

- Collection<V> values() - -
- Returns a collection view of the values contained in this map.

- - - - - - - - -

Methods inherited from class com.sleepycat.collections.StoredContainer
`areDuplicatesAllowed, areDuplicatesOrdered, areKeyRangesAllowed, areKeysRenumbered, clear, getCursorConfig, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed`

- - - - - - - - -

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - - - - - - - -

Methods inherited from interface java.util.Map
`clear, isEmpty`

- -

- +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`K`	`append(V value)` + Appends a given value returning the newly assigned key. +
`boolean`	`containsKey(java.lang.Object key)` + Returns true if this map contains the specified key. +
`boolean`	`containsValue(java.lang.Object value)` + Returns true if this map contains the specified value. +
`java.util.Collection<V>`	`duplicates(K key)` + Returns a new collection containing the values mapped to the given key + in this map. +
`<PK> java.util.Map<PK,V>`	`duplicatesMap(K secondaryKey, + EntryBinding primaryKeyBinding)` + Returns a new map from primary key to value for the subset of records + having a given secondary key (duplicates). +
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()` + Returns a set view of the mappings contained in this map. +
`boolean`	`equals(java.lang.Object other)` + Compares the specified object with this map for equality. +
`V`	`get(java.lang.Object key)` + Returns the value to which this map maps the specified key. +
`int`	`hashCode()`
`java.util.Set<K>`	`keySet()` + Returns a set view of the keys contained in this map. +
`V`	`put(K key, + V value)` + Associates the specified value with the specified key in this map + (optional operation). +
`void`	`putAll(java.util.Map<? extends K,? extends V> map)` + Copies all of the mappings from the specified map to this map (optional + operation). +
`V`	`putIfAbsent(K key, + V value)` + If the specified key is not already associated with a value, associate + it with the given value. +
`V`	`remove(java.lang.Object key)` + Removes the mapping for this key from this map if present (optional + operation). +
`boolean`	`remove(java.lang.Object key, + java.lang.Object value)` + Remove entry for key only if currently mapped to given value. +
`V`	`replace(K key, + V value)` + Replace entry for key only if currently mapped to some value. +
`boolean`	`replace(K key, + V oldValue, + V newValue)` + Replace entry for key only if currently mapped to given value. +
`int`	`size()` + Returns a non-transactional count of the records in the collection or + map. +
`java.lang.String`	`toString()` + Converts the map to a string representation for debugging. +
`java.util.Collection<V>`	`values()` + Returns a collection view of the values contained in this map. +

+ + +
Methods inherited from class com.sleepycat.collections.StoredContainer
+areDuplicatesAllowed, areDuplicatesOrdered, areKeyRangesAllowed, areKeysRenumbered, clear, getCursorConfig, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ + +
Methods inherited from interface java.util.Map
+clear, isEmpty

- - - - - - -
-Constructor Detail
- -
-StoredMap
-
```
-public StoredMap(Database database,
-                 EntryBinding<K> keyBinding,
-                 EntryBinding<V> valueBinding,
-                 boolean writeAllowed)
```
-
-
Creates a map 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.
valueBinding - is the binding used to translate between value - buffers and value 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 checked exception is thrown, - including a DatabaseException on BDB (C edition).
-
-
- -
-StoredMap
-
```
-public StoredMap(Database database,
-                 EntryBinding<K> keyBinding,
-                 EntryBinding<V> valueBinding,
-                 PrimaryKeyAssigner keyAssigner)
```
-
-
Creates a map view of a Database with a PrimaryKeyAssigner. Writing is allowed for the created map. -
-
-
Parameters:
database - is the Database underlying the new collection.
keyBinding - is the binding used to translate between key buffers - and key objects.
valueBinding - is the binding used to translate between value - buffers and value objects.
keyAssigner - is used by the append(V) method to assign - primary keys. -
Throws: -
IllegalArgumentException - if formats are not consistently - defined or a parameter is invalid. -
RuntimeExceptionWrapper - if a checked exception is thrown, - including a DatabaseException on BDB (C edition).
-
-
- -
-StoredMap
-
```
-public StoredMap(Database database,
-                 EntryBinding<K> keyBinding,
-                 EntityBinding<V> valueEntityBinding,
-                 boolean writeAllowed)
```
-
-
Creates a map entity 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.
valueEntityBinding - is the binding used to translate between - key/value buffers and entity value 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 checked exception is thrown, - including a DatabaseException on BDB (C edition).
-
-
- -
-StoredMap
-
```
-public StoredMap(Database database,
-                 EntryBinding<K> keyBinding,
-                 EntityBinding<V> valueEntityBinding,
-                 PrimaryKeyAssigner keyAssigner)
```
-
-
Creates a map entity view of a Database with a PrimaryKeyAssigner. Writing is allowed for the created map. -
-
-
Parameters:
database - is the Database underlying the new collection.
keyBinding - is the binding used to translate between key buffers - and key objects.
valueEntityBinding - is the binding used to translate between - key/value buffers and entity value objects.
keyAssigner - is used by the append(V) method to assign - primary keys. -
Throws: -
IllegalArgumentException - if formats are not consistently - defined or a parameter is invalid. -
RuntimeExceptionWrapper - if a checked exception is thrown, - including a DatabaseException on BDB (C edition).
-
- +
- + + +
  Constructor Detail
  + + + +
  - +
    StoredMap
    +
```
public StoredMap(Database database,
+         EntryBinding<K> keyBinding,
+         EntryBinding<V> valueBinding,
+         boolean writeAllowed)
```
    +
    Creates a map 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.
    valueBinding - is the binding used to translate between value + buffers and value objects.
    writeAllowed - is true to create a read-write collection or false + to create a read-only collection.
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if formats are not consistently + defined or a parameter is invalid.
    +
    RuntimeExceptionWrapper - if a checked exception is thrown, + including a DatabaseException on BDB (C edition).
    +
  + + + +
  - +
    StoredMap
    +
```
public StoredMap(Database database,
+         EntryBinding<K> keyBinding,
+         EntryBinding<V> valueBinding,
+         PrimaryKeyAssigner keyAssigner)
```
    +
    Creates a map view of a Database with a PrimaryKeyAssigner. Writing is allowed for the created map.
    +
    Parameters:
    database - is the Database underlying the new collection.
    keyBinding - is the binding used to translate between key buffers + and key objects.
    valueBinding - is the binding used to translate between value + buffers and value objects.
    keyAssigner - is used by the append(V) method to assign + primary keys.
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if formats are not consistently + defined or a parameter is invalid.
    +
    RuntimeExceptionWrapper - if a checked exception is thrown, + including a DatabaseException on BDB (C edition).
    +
  + + + +
  - +
    StoredMap
    +
```
public StoredMap(Database database,
+         EntryBinding<K> keyBinding,
+         EntityBinding<V> valueEntityBinding,
+         boolean writeAllowed)
```
    +
    Creates a map entity 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.
    valueEntityBinding - is the binding used to translate between + key/value buffers and entity value objects.
    writeAllowed - is true to create a read-write collection or false + to create a read-only collection.
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if formats are not consistently + defined or a parameter is invalid.
    +
    RuntimeExceptionWrapper - if a checked exception is thrown, + including a DatabaseException on BDB (C edition).
    +
  + + + +
  - +
    StoredMap
    +
```
public StoredMap(Database database,
+         EntryBinding<K> keyBinding,
+         EntityBinding<V> valueEntityBinding,
+         PrimaryKeyAssigner keyAssigner)
```
    +
    Creates a map entity view of a Database with a PrimaryKeyAssigner. Writing is allowed for the created map.
    +
    Parameters:
    database - is the Database underlying the new collection.
    keyBinding - is the binding used to translate between key buffers + and key objects.
    valueEntityBinding - is the binding used to translate between + key/value buffers and entity value objects.
    keyAssigner - is used by the append(V) method to assign + primary keys.
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if formats are not consistently + defined or a parameter is invalid.
    +
    RuntimeExceptionWrapper - if a checked exception is thrown, + including a DatabaseException on BDB (C edition).
    +
  +
- - - - - - -
-Method Detail
- -
-get
-
```
-public V get(Object key)
```
-
-
Returns the value to which this map maps the specified key. If +
- + + +
  Method Detail
  + + + +
  - +
    get
    +
    public V get(java.lang.Object key)
    +
    Returns the value to which this map maps the specified key. If duplicates are allowed, this method returns the first duplicate, in the order in which duplicates are configured, that maps to the specified key. - This method conforms to the Map.get(java.lang.Object) interface. -
    -
    -
    Specified by:
    get in interface Map<K,V>
    -
    -
    - -
    Throws: -
    RuntimeExceptionWrapper - if a checked exception is thrown, - including a DatabaseException on BDB (C edition).
    -
    -
-
- -
-put
-
```
-public V put(K key,
-             V value)
```
-
-
Associates the specified value with the specified key in this map + This method conforms to the Map.get(java.lang.Object) interface.

- -com.sleepycat.collections - -Class StoredMap<K,V>

Class StoredMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.sleepycat.collections.StoredContainer

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

-StoredMap

-StoredMap

-StoredMap

-StoredMap

Constructor Detail

StoredMap

StoredMap

StoredMap

StoredMap

-get

Method Detail

get

-put

put

-append

append

-remove

remove

-putIfAbsent

-remove

-replace

-replace

-containsKey

-containsValue

putIfAbsent

remove

replace

replace

containsKey

containsValue

-putAll

putAll

-keySet

keySet

-entrySet

entrySet

-values

values

-duplicates

duplicates

-duplicatesMap

duplicatesMap

-equals

equals

-hashCode

-size

-toString

hashCode

size

toString

- -com.sleepycat.collections -
-Class StoredMap<K,V>