Apache::Geode::Client::CacheableFileName Class Reference

An immutable filename wrapper that can serve as a distributable key object for caching as well as being a string value. More...

Inherits Apache::Geode::Client::ICacheableKey.

Public Member Functions
virtual bool	Equals (ICacheableKey^ other)
	Return true if this key matches other object. More...
virtual bool	Equals (Object^ obj) override
	Return true if this key matches other object. More...
virtual IGeodeSerializable^	FromData (DataInput^ input)
	Deserialize this object, typical implementation should return the 'this' pointer. More...
virtual System::Int32	GetHashCode () override
	Return the hashcode for this key. More...
virtual void	ToData (DataOutput^ output)
	Serializes this object. More...
virtual String^	ToString () override
	Return a string representation of the object. More...

Static Public Member Functions
static CacheableFileName^	Create (String^ value)
	Static function to create a new instance from the given string. More...
static CacheableFileName^	Create (array< Char >^value)
	Static function to create a new instance from the given character array. More...

Properties
virtual System::UInt32	ClassId [get]
	Returns the classId of the instance being serialized. More...
virtual System::UInt32	ObjectSize [get]
	return the size of this object in bytes More...
String^	Value [get]
	Gets the string value. More...

Detailed Description

An immutable filename wrapper that can serve as a distributable key object for caching as well as being a string value.

Member Function Documentation

static CacheableFileName ^ Apache::Geode::Client::CacheableFileName::Create ( String^  value )

inlinestatic

Static function to create a new instance from the given string.

static CacheableFileName ^ Apache::Geode::Client::CacheableFileName::Create ( array< Char >^  value )

inlinestatic

Static function to create a new instance from the given character array.

virtual bool Apache::Geode::Client::CacheableFileName::Equals ( ICacheableKey^  other )

virtual

Return true if this key matches other object.

Implements Apache::Geode::Client::ICacheableKey.

virtual bool Apache::Geode::Client::CacheableFileName::Equals ( Object^  obj )

overridevirtual

Return true if this key matches other object.

virtual IGeodeSerializable ^ Apache::Geode::Client::CacheableFileName::FromData ( DataInput^  input )

virtual

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

Parameters

input

the DataInput stream to use for reading the object data

Returns

the deserialized object

Implements Apache::Geode::Client::IGeodeSerializable.

virtual System::Int32 Apache::Geode::Client::CacheableFileName::GetHashCode ( )

overridevirtual

Return the hashcode for this key.

Implements Apache::Geode::Client::ICacheableKey.

virtual void Apache::Geode::Client::CacheableFileName::ToData ( DataOutput^  output )

virtual

Serializes this object.

Parameters

output

the DataOutput object to use for serializing the object

Implements Apache::Geode::Client::IGeodeSerializable.

virtual String ^ Apache::Geode::Client::CacheableFileName::ToString ( )

inlineoverridevirtual

Return a string representation of the object.

This returns the same string as Value property.

Implements Apache::Geode::Client::IGeodeSerializable.

Property Documentation

virtual System:: UInt32 Apache::Geode::Client::CacheableFileName::ClassId

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

virtual System:: UInt32 Apache::Geode::Client::CacheableFileName::ObjectSize

get

return the size of this object in bytes

String^ Apache::Geode::Client::CacheableFileName::Value

get

Gets the string value.