Apache Geode Native .NET Reference  1.14.0
Apache::Geode::Client::CacheableHashMap Class Reference

A mutable ICacheableKey to ISerializable hash map that can serve as a distributable object for caching. More...

Inherits Apache::Geode::Client::IDataSerializablePrimitive.

Inherited by Apache::Geode::Client::CacheableHashTable, and Apache::Geode::Client::CacheableIdentityHashMap.

Public Member Functions

 CacheableHashMap ()
 Allocates a new empty instance. More...
 
 CacheableHashMap (Object^ dictionary)
 Allocates a new instance copying from the given dictionary. More...
 
virtual void FromData (DataInput^ input)
 Deserialize this object, typical implementation should return the 'this' pointer. More...
 
virtual void ToData (DataOutput^ output)
 Serializes this object. More...
 
String ^ ToString ()
 Return a string representation of the object. More...
 

Static Public Member Functions

static CacheableHashMapCreate ()
 Static function to create a new empty instance. More...
 
static CacheableHashMapCreate (Object^ dictionary)
 Static function to create a new instance copying from the given dictionary. More...
 
static ISerializableCreateDeserializable ()
 Factory function to register this class. More...
 

Properties

int8_t DsCode [get]
 Returns the classId of the instance being serialized. More...
 
virtual System::UInt64 ObjectSize [get]
 return the size of this object in bytes More...
 

Detailed Description

A mutable ICacheableKey to ISerializable hash map that can serve as a distributable object for caching.

This class extends .NET generic Dictionary class.

Constructor & Destructor Documentation

◆ CacheableHashMap() [1/2]

Apache::Geode::Client::CacheableHashMap::CacheableHashMap ( )
inline

Allocates a new empty instance.

◆ CacheableHashMap() [2/2]

Apache::Geode::Client::CacheableHashMap::CacheableHashMap ( Object^  dictionary)
inline

Allocates a new instance copying from the given dictionary.

Parameters
dictionaryThe dictionary whose elements are copied to this HashMap.

Member Function Documentation

◆ Create() [1/2]

static CacheableHashMap ^ Apache::Geode::Client::CacheableHashMap::Create ( )
inlinestatic

Static function to create a new empty instance.

◆ Create() [2/2]

static CacheableHashMap ^ Apache::Geode::Client::CacheableHashMap::Create ( Object^  dictionary)
inlinestatic

Static function to create a new instance copying from the given dictionary.

◆ CreateDeserializable()

static ISerializable ^ Apache::Geode::Client::CacheableHashMap::CreateDeserializable ( )
inlinestatic

Factory function to register this class.

◆ FromData()

virtual void Apache::Geode::Client::CacheableHashMap::FromData ( DataInput input)
virtual

Deserialize this object, typical implementation should return the 'this' pointer.

Parameters
inputthe DataInput stream to use for reading the object data
Returns
the deserialized object

Reimplemented in Apache::Geode::Client::CacheableHashTable.

◆ ToData()

virtual void Apache::Geode::Client::CacheableHashMap::ToData ( DataOutput output)
virtual

Serializes this object.

Parameters
outputthe DataOutput object to use for serializing the object

◆ ToString()

String ^ Apache::Geode::Client::ISerializable::ToString ( )
inherited

Return a string representation of the object.

Implemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< NativeArray, NativeArray, ManagedType, DsCode >, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::Properties< String^, String^>, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Serializable, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)>, and Apache::Geode::Client::CacheableFileName.

Property Documentation

◆ DsCode

int8_t Apache::Geode::Client::CacheableHashMap::DsCode
get

Returns the classId of the instance being serialized.

This is used by deserialization to determine what instance type to create and deserialize into.

Returns
the classId

◆ ObjectSize

virtual System:: UInt64 Apache::Geode::Client::CacheableHashMap::ObjectSize
get

return the size of this object in bytes


Apache Geode C++ Cache .NET API Documentation