GemStone::GemFire::Cache::CacheableFileName Class Reference

Inherits GemStone::GemFire::Cache::ICacheableKey.

---

Detailed Description

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

Public Member Functions
	CacheableFileName (array< Char >^value)
	CacheableFileName (String^ value)
	CacheableFileName ()
virtual Boolean	Equals (Object^ obj) override
virtual Boolean	Equals (ICacheableKey^ other)
virtual IGFSerializable^	FromData (DataInput^ input)
virtual Int32	GetHashCode () override
virtual void	ToData (DataOutput^ output)
virtual String^	ToString () override
Properties
virtual Byte	ClassId [get]
virtual UInt32	ObjectSize [get]
String^	Value [get]

---

Constructor & Destructor Documentation

GemStone::GemFire::Cache::CacheableFileName::CacheableFileName

(

)

[inline]

Allocates a new empty instance.

GemStone::GemFire::Cache::CacheableFileName::CacheableFileName

(

String^

value

)

[inline]

Allocates a new instance from the given string.

Exceptions:

IllegalArgumentException

If the packed CacheableFileName is greater than or equal 64K in length.

GemStone::GemFire::Cache::CacheableFileName::CacheableFileName

(

array< Char >^

value

)

[inline]

Allocates a new instance copying from the given character array.

Exceptions:

IllegalArgumentException

If the packed CacheableFileName is greater than or equal 64K in length.

---

Member Function Documentation

virtual Boolean GemStone::GemFire::Cache::CacheableFileName::Equals

(

Object^

obj

)

[override, virtual]

Return true if this key matches other object.

virtual Boolean GemStone::GemFire::Cache::CacheableFileName::Equals

(

ICacheableKey^

other

)

[virtual]

Return true if this key matches other object.

Implements GemStone::GemFire::Cache::ICacheableKey.

virtual IGFSerializable ^ GemStone::GemFire::Cache::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 GemStone::GemFire::Cache::IGFSerializable.

virtual Int32 GemStone::GemFire::Cache::CacheableFileName::GetHashCode

(

)

[override, virtual]

Return the hashcode for this key.

Implements GemStone::GemFire::Cache::ICacheableKey.

virtual void GemStone::GemFire::Cache::CacheableFileName::ToData

(

DataOutput^

output

)

[virtual]

Serializes this object.

Parameters:

output

the DataOutput object to use for serializing the object

Implements GemStone::GemFire::Cache::IGFSerializable.

virtual String ^ GemStone::GemFire::Cache::CacheableFileName::ToString

(

)

[inline, override, virtual]

Return a string representation of the object. This returns the same string as Value property.

Implements GemStone::GemFire::Cache::IGFSerializable.

---

Property Documentation

virtual Byte GemStone::GemFire::Cache::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

Implements GemStone::GemFire::Cache::IGFSerializable.

virtual UInt32 GemStone::GemFire::Cache::CacheableFileName::ObjectSize [get]

return the size of this object in bytes

Implements GemStone::GemFire::Cache::IGFSerializable.

String^ GemStone::GemFire::Cache::CacheableFileName::Value [get]

Gets the string value.

---