com.ibm.websphere.objectgrid.plugins.io
Interface MapSerializerPlugin

All Superinterfaces:

BackingMapPlugin, Destroyable, Initializable

All Known Implementing Classes:

BasicMapSerializerPlugin

public interface MapSerializerPlugin
extends BackingMapPlugin

Identifies how data is formatted in a map and how it is serialized. The MapDataDescriptor describes any relationships between this map an another map.

A map can only have one MapSerializerPlugin. See the SerializerAccessor for detials on registering a MapSerializerPlugin with a BackingMap.

The BasicMapSerializerPlugin class is a concrete implementation of a MapSerializerPlugin that can be used directly in the ObjectGrid configuration or can be extended to provide custom capabilities.

Since:

7.1.1

Method Summary

KeySerializerPlugin	getKeySerializerPlugin() The KeySerializer to use for all key entries in the map.
MapDataDescriptor	getMapDataDescriptor() The MapDataDescriptor that describes the map.
ValueSerializerPlugin	getValueSerializerPlugin() The ValueSerializer to use for all value entries in the map.

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.BackingMapPlugin

getBackingMap, setBackingMap

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.Initializable

initialize, isInitialized

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.Destroyable

destroy, isDestroyed

Method Detail

getMapDataDescriptor

MapDataDescriptor getMapDataDescriptor()

The MapDataDescriptor that describes the map.

Returns:

the MapDataDescriptor

getKeySerializerPlugin

KeySerializerPlugin getKeySerializerPlugin()

The KeySerializer to use for all key entries in the map.

Returns:

the KeySerializer or null if none.

getValueSerializerPlugin

ValueSerializerPlugin getValueSerializerPlugin()

The ValueSerializer to use for all value entries in the map.

Returns:

the ValueSerializer or null if none.