Oracle® Coherence Java API Reference
v3.5.3

E15583-01

com.tangosol.util
Class ConverterCollections.ConverterMapEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.tangosol.util.MapEvent
          extended by com.tangosol.util.ConverterCollections.ConverterMapEvent
All Implemented Interfaces:
java.io.Serializable
Enclosing class:
ConverterCollections

public static class ConverterCollections.ConverterMapEvent
extends MapEvent

A Converter MapEvent views an underlying MapEvent through a set of key and value Converters.


Nested Class Summary
protected  class ConverterCollections.ConverterMapEvent.ConverterMapEventEntry
          ConverterMapEventEntry provides both the Map Entry and the BinaryEntry interface to the information encapsulated inside the ConvertMapEvent.
 
Field Summary
protected  BackingMapManagerContext m_context
          The BackingMapManagerContext to use for extracting binary values.
protected  Converter m_convKey
          The Converter to view the underlying MapEvent's key.
protected  Converter m_convVal
          The Converter to view the underlying MapEvent's value.
protected  MapEvent m_event
          The underlying MapEvent.
static java.lang.Object NO_VALUE
          Tag object indicating that a corresponding value has not been converted.
 
Fields inherited from class com.tangosol.util.MapEvent
ENTRY_DELETED, ENTRY_INSERTED, ENTRY_UPDATED, m_nId, m_oKey, m_oValueNew, m_oValueOld
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ConverterCollections.ConverterMapEvent(ObservableMap map, MapEvent event, Converter convKey, Converter convVal)
          Construct a ConverterMapEvent.
ConverterCollections.ConverterMapEvent(ObservableMap map, MapEvent event, Converter convKey, Converter convVal, BackingMapManagerContext context)
          Construct a ConverterMapEvent.
 
Method Summary
 BackingMapManagerContext getContext()
          Get the BackingMapManagerContext if one was provided.
 Converter getConverterKeyUp()
          Return the Converter used to view the underlying MapEvent's key through.
 Converter getConverterValueUp()
          Return the Converter used to view the underlying MapEvent's value through.
 java.lang.Object getKey()
          Return a key associated with this event.
 MapEvent getMapEvent()
          Return the underlying MapEvent.
 java.util.Map.Entry getNewEntry()
          Return a Map Entry that represents the state of the Entry after the change occurred that generated this event.
 java.lang.Object getNewValue()
          Return a new value associated with this event.
 java.util.Map.Entry getOldEntry()
          Return a Map Entry that represents the state of the Entry before the change occurred that generated this event.
 java.lang.Object getOldValue()
          Return an old value associated with this event.
 boolean isKeyConverted()
          Check if the event's key has been converted.
 boolean isNewValueConverted()
          Check if the event's new value has been converted.
 boolean isOldValueConverted()
          Check if the event's old value has been converted.
 void setKey(java.lang.Object oKey)
          Set the cached converted old value associated with this event.
 void setNewValue(java.lang.Object oValue)
          Set the cached converted new value associated with this event.
 void setOldValue(java.lang.Object oValue)
          Set the cached converted old value associated with this event.
 
Methods inherited from class com.tangosol.util.MapEvent
dispatch, dispatch, dispatch, getDescription, getDescription, getId, getMap, toString
 
Methods inherited from class java.util.EventObject
getSource
 

Field Detail

NO_VALUE

public static final java.lang.Object NO_VALUE
Tag object indicating that a corresponding value has not been converted.


m_event

protected MapEvent m_event
The underlying MapEvent.


m_convKey

protected Converter m_convKey
The Converter to view the underlying MapEvent's key.


m_convVal

protected Converter m_convVal
The Converter to view the underlying MapEvent's value.


m_context

protected BackingMapManagerContext m_context
The BackingMapManagerContext to use for extracting binary values.

Constructor Detail

ConverterCollections.ConverterMapEvent

public ConverterCollections.ConverterMapEvent(ObservableMap map,
                                              MapEvent event,
                                              Converter convKey,
                                              Converter convVal)
Construct a ConverterMapEvent.

Parameters:
event - the underlying MapEvent
map - the new event's source
convKey - the Converter to view the underlying MapEvent's key
convVal - the Converter to view the underlying MapEvent's values

ConverterCollections.ConverterMapEvent

public ConverterCollections.ConverterMapEvent(ObservableMap map,
                                              MapEvent event,
                                              Converter convKey,
                                              Converter convVal,
                                              BackingMapManagerContext context)
Construct a ConverterMapEvent.

Parameters:
event - the underlying MapEvent
map - the new event's source
convKey - the Converter to view the underlying MapEvent's key
convVal - the Converter to view the underlying MapEvent's values
context - the BackingMapManagerContext necessary to emulate the BinaryEntry interface
Method Detail

getKey

public java.lang.Object getKey()
Return a key associated with this event.

Overrides:
getKey in class MapEvent
Returns:
a key

getOldValue

public java.lang.Object getOldValue()
Return an old value associated with this event.

The old value represents a value deleted from or updated in a map. It is always null for "insert" notifications.

Overrides:
getOldValue in class MapEvent
Returns:
an old value

getNewValue

public java.lang.Object getNewValue()
Return a new value associated with this event.

The new value represents a new value inserted into or updated in a map. It is always null for "delete" notifications.

Overrides:
getNewValue in class MapEvent
Returns:
a new value

getOldEntry

public java.util.Map.Entry getOldEntry()
Return a Map Entry that represents the state of the Entry before the change occurred that generated this event.

Overrides:
getOldEntry in class MapEvent
Returns:
a Map Entry representing the pre-event state of the Entry

getNewEntry

public java.util.Map.Entry getNewEntry()
Return a Map Entry that represents the state of the Entry after the change occurred that generated this event.

Overrides:
getNewEntry in class MapEvent
Returns:
a Map Entry representing the post-event state of the Entry

getMapEvent

public MapEvent getMapEvent()
Return the underlying MapEvent.

Returns:
the underlying MapEvent

getContext

public BackingMapManagerContext getContext()
Get the BackingMapManagerContext if one was provided.

Returns:
the BackingMapManagerContext

getConverterKeyUp

public Converter getConverterKeyUp()
Return the Converter used to view the underlying MapEvent's key through.

Returns:
the Converter from the underlying MapEvent's key

getConverterValueUp

public Converter getConverterValueUp()
Return the Converter used to view the underlying MapEvent's value through.

Returns:
the Converter from the underlying MapEvent's value

setKey

public void setKey(java.lang.Object oKey)
Set the cached converted old value associated with this event.

Parameters:
oKey - the converted key value

setOldValue

public void setOldValue(java.lang.Object oValue)
Set the cached converted old value associated with this event.

Parameters:
oValue - the new converted "old" value

setNewValue

public void setNewValue(java.lang.Object oValue)
Set the cached converted new value associated with this event.

Parameters:
oValue - the new converted "new" value

isKeyConverted

public boolean isKeyConverted()
Check if the event's key has been converted.

Returns:
true iff the key has been converted

isOldValueConverted

public boolean isOldValueConverted()
Check if the event's old value has been converted.

Returns:
true iff the old value has been converted

isNewValueConverted

public boolean isNewValueConverted()
Check if the event's new value has been converted.

Returns:
true iff the new value has been converted

Oracle® Coherence Java API Reference
v3.5.3

E15583-01

Copyright © 2000, 2010, Oracle. All rights reserved.