Hazelcast C++ Client
Public Member Functions | List of all members
hazelcast::client::EntryEvent< K, V > Class Template Reference

Map Entry event. More...

#include <EntryEvent.h>

Public Member Functions

 EntryEvent (const std::string &name, const Member &member, EntryEventType eventType, std::auto_ptr< K > key, std::auto_ptr< V > value)
 Constructor.
 
 EntryEvent (const std::string &name, const Member &member, EntryEventType eventType, std::auto_ptr< K > key, std::auto_ptr< V > value, std::auto_ptr< V > oldValue, std::auto_ptr< V > mergingValue)
 Constructor.
 
const K * getKeyObject () const
 Returns the key of the entry event. More...
 
std::auto_ptr< K > releaseKey ()
 Releases the key of the entry event. More...
 
const K & getKey () const
 
const V * getOldValueObject () const
 Returns the old value of the entry event. More...
 
std::auto_ptr< V > releaseOldValue ()
 Releases the old value of the entry event. More...
 
const V & getOldValue () const
 
const V * getValueObject () const
 Returns the value of the entry event. More...
 
std::auto_ptr< V > releaseValue ()
 Releases the value of the entry event. More...
 
const V & getValue () const
 
const V * getMergingValueObject () const
 Returns the incoming merging value of the entry event. More...
 
std::auto_ptr< V > releaseMergingValue () const
 Releases the mergingValue of the entry event. More...
 
const V & getMergingValue () const
 
const MembergetMember () const
 Returns the member fired this event. More...
 
EntryEventType getEventType () const
 Return the event type. More...
 
const std::string & getName () const
 Returns the name of the map for this event. More...
 
std::ostream & operator<< (std::ostream &out) const
 

Detailed Description

template<typename K, typename V>
class hazelcast::client::EntryEvent< K, V >

Map Entry event.

Parameters
<K>key of the map entry
<V>value of the map entry
See also
EntryListener
IMap::addEntryListener(EntryListener, boolean)

Member Function Documentation

template<typename K, typename V>
EntryEventType hazelcast::client::EntryEvent< K, V >::getEventType ( ) const
inline

Return the event type.

Returns
event type
template<typename K, typename V>
const K& hazelcast::client::EntryEvent< K, V >::getKey ( ) const
inline
Deprecated:
This API is deprecated in favor of
See also
{getKeyObject} and
{releaseKey}. It may be removed in the next releases.

Returns the key of the entry event

Returns
the key
template<typename K, typename V>
const K* hazelcast::client::EntryEvent< K, V >::getKeyObject ( ) const
inline

Returns the key of the entry event.

Returns
the key
template<typename K, typename V>
const Member& hazelcast::client::EntryEvent< K, V >::getMember ( ) const
inline

Returns the member fired this event.

Returns
the member fired this event.
template<typename K, typename V>
const V& hazelcast::client::EntryEvent< K, V >::getMergingValue ( ) const
inline
Deprecated:
This API is deprecated in favor of
See also
{getMergingValueObject} and
{releaseMergingValue}. It may be removed in the next releases.

Returns the incoming merging value of the entry event.

Returns
merging value
template<typename K, typename V>
const V* hazelcast::client::EntryEvent< K, V >::getMergingValueObject ( ) const
inline

Returns the incoming merging value of the entry event.

Returns
The merging value
template<typename K, typename V>
const std::string& hazelcast::client::EntryEvent< K, V >::getName ( ) const
inline

Returns the name of the map for this event.

Returns
name of the map.
template<typename K, typename V>
const V& hazelcast::client::EntryEvent< K, V >::getOldValue ( ) const
inline
Deprecated:
This API is deprecated in favor of
See also
{getOldValueObject} and
{releaseOldValue}. It may be removed in the next releases.

Returns the old value of the entry event

Returns
The older value for the entry
template<typename K, typename V>
const V* hazelcast::client::EntryEvent< K, V >::getOldValueObject ( ) const
inline

Returns the old value of the entry event.

Returns
The older value for the entry
template<typename K, typename V>
const V& hazelcast::client::EntryEvent< K, V >::getValue ( ) const
inline
Deprecated:
This API is deprecated in favor of
See also
{getValueObject} and
{releaseValue}. It may be removed in the next releases.

Returns the value of the entry event

Returns
The value of for the entry
template<typename K, typename V>
const V* hazelcast::client::EntryEvent< K, V >::getValueObject ( ) const
inline

Returns the value of the entry event.

Returns
The value for the entry
template<typename K, typename V>
std::auto_ptr<K> hazelcast::client::EntryEvent< K, V >::releaseKey ( )
inline

Releases the key of the entry event.

It resets the key in the event, calling getKeyObject, releaseKeyObject after calling releaseKey shall return NULL pointer.

Returns
the key
template<typename K, typename V>
std::auto_ptr<V> hazelcast::client::EntryEvent< K, V >::releaseMergingValue ( ) const
inline

Releases the mergingValue of the entry event.

It resets the value in the event, calling getmergingValueObject, releasemergingValue after calling releasemergingValue shall return NULL pointer.

Returns the incoming merging value of the entry event.

Returns
merging value
template<typename K, typename V>
std::auto_ptr<V> hazelcast::client::EntryEvent< K, V >::releaseOldValue ( )
inline

Releases the old value of the entry event.

It resets the oldValue in the event, calling getOldValueObject, releaseOldValue after calling releaseOldValue shall return NULL pointer.

Returns the old value of the entry event

Returns
The older value for the entry
template<typename K, typename V>
std::auto_ptr<V> hazelcast::client::EntryEvent< K, V >::releaseValue ( )
inline

Releases the value of the entry event.

It resets the value in the event, calling getValueObject, releaseValue after calling releaseValue shall return NULL pointer.

Returns the old value of the entry event

Returns
The older value for the entry

The documentation for this class was generated from the following file: