org.datanucleus.store.scostore

Interface MapStore

All Superinterfaces:

Store

public interface MapStore
extends Store

Interface representation of the backing store for a Map.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(ObjectProvider op) Method to clear the map.
boolean	containsKey(ObjectProvider op, Object key) Accessor for whether the Map contains this key.
boolean	containsValue(ObjectProvider op, Object value) Accessor for whether the Map contains this value.
SetStore	entrySetStore() Accessor for the entry set for the Map.
Object	get(ObjectProvider op, Object key) Accessor for a value from the Map.
boolean	keysAreEmbedded() Accessor for whether the keys are embedded.
boolean	keysAreSerialised() Accessor for whether the keys are serialised.
SetStore	keySetStore() Accessor for the keys in the Map.
Object	put(ObjectProvider op, Object key, Object value) Method to add a value to the Map against this key.
void	putAll(ObjectProvider op, Map m) Method to add a map of values to the Map.
Object	remove(ObjectProvider op, Object key) Method to remove a value from the Map.
Object	remove(ObjectProvider op, Object key, Object val) Method to remove a value from the Map.
boolean	updateEmbeddedKey(ObjectProvider op, Object key, int fieldNumber, Object newValue) Method to update en embedded key in the map.
boolean	updateEmbeddedValue(ObjectProvider op, Object value, int fieldNumber, Object newValue) Method to update en embedded value in the map.
boolean	valuesAreEmbedded() Accessor for whether the values are embedded.
boolean	valuesAreSerialised() Accessor for whether the values are serialised.
SetStore	valueSetStore() Accessor for the values in the Map.

Methods inherited from interface org.datanucleus.store.scostore.Store

getOwnerMemberMetaData, getStoreManager

Method Detail

keysAreEmbedded

boolean keysAreEmbedded()

Accessor for whether the keys are embedded.

Returns:

Whether we have embedded keys

keysAreSerialised

boolean keysAreSerialised()

Accessor for whether the keys are serialised.

Returns:

Whether we have serialised keys

valuesAreEmbedded

boolean valuesAreEmbedded()

Accessor for whether the values are embedded.

Returns:

Whether we have embedded values

valuesAreSerialised

boolean valuesAreSerialised()

Accessor for whether the values are serialised.

Returns:

Whether we have serialised values

containsValue

boolean containsValue(ObjectProvider op,
                    Object value)

Accessor for whether the Map contains this value.

Parameters:

op - ObjectProvider for the owner of the map.

value - The value to check

Returns:

Whether it is contained.

containsKey

boolean containsKey(ObjectProvider op,
                  Object key)

Accessor for whether the Map contains this key.

Parameters:

op - ObjectProvider for the owner of the map.

key - The key to check

Returns:

Whether it is contained.

get

Object get(ObjectProvider op,
         Object key)

Accessor for a value from the Map.

Parameters:

op - ObjectProvider for the owner of the map.

key - Key for the value.

Returns:

Value for this key.

put

Object put(ObjectProvider op,
         Object key,
         Object value)

Method to add a value to the Map against this key.

Parameters:

op - ObjectProvider for the owner of the map.

key - The key.

value - The value.

Returns:

Value that was previously against this key.

putAll

void putAll(ObjectProvider op,
          Map m)

Method to add a map of values to the Map.

Parameters:

op - ObjectProvider for the owner of the map.

m - The map to add.

remove

Object remove(ObjectProvider op,
            Object key)

Method to remove a value from the Map.

Parameters:

op - ObjectProvider for the owner of the map.

key - Key whose value is to be removed.

Returns:

Value that was removed.

remove

Object remove(ObjectProvider op,
            Object key,
            Object val)

Method to remove a value from the Map.

Parameters:

op - ObjectProvider for the owner of the map.

key - Key whose value is to be removed.

val - Value for this key when the value is known (to save the lookup)

Returns:

Value that was removed.

clear

void clear(ObjectProvider op)

Method to clear the map.

Parameters:

op - ObjectProvider for the owner of the map.

keySetStore

SetStore keySetStore()

Accessor for the keys in the Map.

Returns:

Keys for the Map.

valueSetStore

SetStore valueSetStore()

Accessor for the values in the Map.

Returns:

Values for the Map.

entrySetStore

SetStore entrySetStore()

Accessor for the entry set for the Map.

Returns:

Entry set for the Map.

updateEmbeddedKey

boolean updateEmbeddedKey(ObjectProvider op,
                        Object key,
                        int fieldNumber,
                        Object newValue)

Method to update en embedded key in the map.

Parameters:

op - ObjectProvider for the owner of the map

key - The element

fieldNumber - Field to update in the key

newValue - The new value for the field

Returns:

Whether the element was modified

updateEmbeddedValue

boolean updateEmbeddedValue(ObjectProvider op,
                          Object value,
                          int fieldNumber,
                          Object newValue)

Method to update en embedded value in the map.

Parameters:

op - ObjectProvider for the owner of the map

value - The element

fieldNumber - Field to update in the value

newValue - The new value for the field

Returns:

Whether the element was modified