GemStone::GemFire::Cache::CacheableString Class Reference

Inherits GemStone::GemFire::Cache::CacheableKey.


Detailed Description

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

Public Member Functions

 CacheableString (array< Char >^value)
 CacheableString (String^ value)
virtual bool Equals (Object^ obj) override
virtual bool Equals (GemStone::GemFire::Cache::ICacheableKey^ other) override
virtual
GemStone::GemFire::Cache::IGFSerializable
FromData (GemFire::Cache::DataInput^ input) override
virtual int32_t GetHashCode () override
virtual void ToData (GemFire::Cache::DataOutput^ output) override
virtual String^ ToString () override

Static Public Member Functions

static
GemStone::GemFire::Cache::CacheableString
Create (array< Char >^value)
static
GemStone::GemFire::Cache::CacheableString
Create (String^ value)
static bool IsNullOrEmpty (GemStone::GemFire::Cache::CacheableString^ value)
static operator GemStone::GemFire::Cache::CacheableKey^ (String^ value)
static operator GemStone::GemFire::Cache::CacheableKey^ (int64_t value)
static operator GemStone::GemFire::Cache::CacheableKey^ (int32_t value)
static operator GemStone::GemFire::Cache::CacheableKey^ (Char value)
static operator GemStone::GemFire::Cache::CacheableKey^ (int16_t value)
static operator GemStone::GemFire::Cache::CacheableKey^ (Single value)
static operator GemStone::GemFire::Cache::CacheableKey^ (Double value)
static operator GemStone::GemFire::Cache::CacheableKey^ (Byte value)
static operator GemStone::GemFire::Cache::CacheableKey^ (bool value)
static operator GemStone::GemFire::Cache::Serializable^ (array< String^ >^value)
static operator GemStone::GemFire::Cache::Serializable^ (String^ value)
static operator GemStone::GemFire::Cache::Serializable^ (array< int64_t >^value)
static operator GemStone::GemFire::Cache::Serializable^ (array< int32_t >^value)
static operator GemStone::GemFire::Cache::Serializable^ (int32_t value)
static operator GemStone::GemFire::Cache::Serializable^ (array< int16_t >^value)
static operator GemStone::GemFire::Cache::Serializable^ (array< Char >^value)
static operator GemStone::GemFire::Cache::Serializable^ (Char value)
static operator GemStone::GemFire::Cache::Serializable^ (int16_t value)
static operator GemStone::GemFire::Cache::Serializable^ (array< Single >^value)
static operator GemStone::GemFire::Cache::Serializable^ (Single value)
static operator GemStone::GemFire::Cache::Serializable^ (array< Double >^value)
static operator GemStone::GemFire::Cache::Serializable^ (Double value)
static operator GemStone::GemFire::Cache::Serializable^ (array< bool >^value)
static operator GemStone::GemFire::Cache::Serializable^ (array< Byte >^value)
static operator GemStone::GemFire::Cache::Serializable^ (Byte value)
static operator GemStone::GemFire::Cache::Serializable^ (bool value)
static operator Serializable^ (int64_t value)
static operator String^ (GemStone::GemFire::Cache::CacheableString^ str)
static void RegisterType (TypeFactoryMethod^ creationMethod)

Properties

virtual uint32_t ClassId [get]
 Returns the classId of the instance being serialized.
bool IsWideString [get]
uint32_t Length [get]
virtual uint32_t ObjectSize [get]
String^  Value [get]

Constructor & Destructor Documentation

GemStone::GemFire::Cache::CacheableString::CacheableString ( String^   value  ) 

Allocates a new instance copying from the given string.

Parameters:
value the string value of the new instance
Exceptions:
IllegalArgumentException if the provided string is null or has zero length

GemStone::GemFire::Cache::CacheableString::CacheableString ( array< Char >^  value  ) 

Allocates a new instance copying from the given character array.

Parameters:
value the character array value of the new instance
Exceptions:
IllegalArgumentException if the provided array is null or has zero length


Member Function Documentation

static GemStone::GemFire::Cache::CacheableString ^ GemStone::GemFire::Cache::CacheableString::Create ( array< Char >^  value  )  [inline, static]

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

Providing a null or zero size character array will return a null CacheableString object.

Parameters:
value the character array value of the new instance

static GemStone::GemFire::Cache::CacheableString ^ GemStone::GemFire::Cache::CacheableString::Create ( String^   value  )  [inline, static]

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

Providing a null or zero size string will return a null CacheableString object.

Parameters:
value the string value of the new instance

virtual bool GemStone::GemFire::Cache::CacheableString::Equals ( Object^   obj  )  [override, virtual]

Return true if this key matches other object. It invokes the '==' operator of the underlying gemfire::CacheableString object.

Reimplemented from GemStone::GemFire::Cache::CacheableKey.

virtual bool GemStone::GemFire::Cache::CacheableString::Equals ( GemStone::GemFire::Cache::ICacheableKey^   other  )  [override, virtual]

Return true if this key matches other object. It invokes the '==' operator of the underlying gemfire::CacheableString object.

Reimplemented from GemStone::GemFire::Cache::CacheableKey.

virtual GemStone::GemFire::Cache::IGFSerializable ^ GemStone::GemFire::Cache::CacheableString::FromData ( GemFire::Cache::DataInput^   input  )  [override, virtual]

Deserializes the managed object -- returns an instance of the IGFSerializable class.

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

Reimplemented from GemStone::GemFire::Cache::Serializable.

virtual int32_t GemStone::GemFire::Cache::CacheableString::GetHashCode (  )  [override, virtual]

Return the hashcode for this key.

Reimplemented from GemStone::GemFire::Cache::CacheableKey.

static bool GemStone::GemFire::Cache::CacheableString::IsNullOrEmpty ( GemStone::GemFire::Cache::CacheableString^   value  )  [inline, static]

Static function to check whether IsNullOrEmpty.

This is similar to the C# string.IsNullOrEmpty method.

Parameters:
value the CacheableString value to check

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( String^   value  )  [static, inherited]

Implicit conversion operator from a string to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( int64_t  value  )  [static, inherited]

Implicit conversion operator from a 64-bit integer to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( int32_t  value  )  [static, inherited]

Implicit conversion operator from a 32-bit integer to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( Char  value  )  [static, inherited]

Implicit conversion operator from a character to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( int16_t  value  )  [static, inherited]

Implicit conversion operator from a 16-bit integer to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( Single  value  )  [static, inherited]

Implicit conversion operator from a float to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( Double  value  )  [static, inherited]

Implicit conversion operator from a double to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( Byte  value  )  [static, inherited]

Implicit conversion operator from a byte to a CacheableKey.

static GemStone::GemFire::Cache::CacheableKey::operator GemStone::GemFire::Cache::CacheableKey^ ( bool  value  )  [static, inherited]

Implicit conversion operator from a boolean to a CacheableKey.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< String^ >^  value  )  [static, inherited]

Implicit conversion operator from a string array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( String^   value  )  [static, inherited]

Implicit conversion operator from a string to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< int64_t >^  value  )  [static, inherited]

Implicit conversion operator from a 64-bit integer array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< int32_t >^  value  )  [static, inherited]

Implicit conversion operator from a 32-bit integer array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( int32_t  value  )  [static, inherited]

Implicit conversion operator from a 32-bit integer to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< int16_t >^  value  )  [static, inherited]

Implicit conversion operator from a 16-bit integer array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< Char >^  value  )  [static, inherited]

Implicit conversion operator from a character array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( Char  value  )  [static, inherited]

Implicit conversion operator from a character to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( int16_t  value  )  [static, inherited]

Implicit conversion operator from a 16-bit integer to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< Single >^  value  )  [static, inherited]

Implicit conversion operator from a float array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( Single  value  )  [static, inherited]

Implicit conversion operator from a float to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< Double >^  value  )  [static, inherited]

Implicit conversion operator from a double array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( Double  value  )  [static, inherited]

Implicit conversion operator from a double to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< bool >^  value  )  [static, inherited]

Implicit conversion operator from an boolean array to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( array< Byte >^  value  )  [static, inherited]

Implicit conversion operator from an array of bytes to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( Byte  value  )  [static, inherited]

Implicit conversion operator from a byte to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator GemStone::GemFire::Cache::Serializable^ ( bool  value  )  [static, inherited]

Implicit conversion operator from a boolean to a Serializable.

static GemStone::GemFire::Cache::Serializable::operator Serializable^ ( int64_t  value  )  [static, inherited]

Implicit conversion operator from a 64-bit integer to a Serializable.

static GemStone::GemFire::Cache::CacheableString::operator String^ ( GemStone::GemFire::Cache::CacheableString^   str  )  [inline, static]

Implicit conversion operator to underlying System.String.

static void GemStone::GemFire::Cache::Serializable::RegisterType ( TypeFactoryMethod^   creationMethod  )  [static, inherited]

Register an instance factory method for a given type. This should be used when registering types that implement IGFSerializable.

Parameters:
creationMethod the creation function to register
Exceptions:
IllegalArgumentException if the method is null
IllegalStateException if the typeId has already been registered, or there is an error in registering the type; check Utils::LastError for more information in the latter case.

virtual void GemStone::GemFire::Cache::CacheableString::ToData ( GemFire::Cache::DataOutput^   output  )  [override, virtual]

Serializes this managed object.

Parameters:
output the DataOutput object to use for serializing the object

Reimplemented from GemStone::GemFire::Cache::Serializable.

virtual String ^ GemStone::GemFire::Cache::CacheableString::ToString (  )  [inline, override, virtual]

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

Reimplemented from GemStone::GemFire::Cache::Serializable.


Property Documentation

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

Reimplemented from GemStone::GemFire::Cache::Serializable.

bool GemStone::GemFire::Cache::CacheableString::IsWideString [get]

True when the underlying C string is a wide-character string.

uint32_t GemStone::GemFire::Cache::CacheableString::Length [get]

Gets the length of the underlying C string.

virtual uint32_t GemStone::GemFire::Cache::CacheableString::ObjectSize [get]

return the size of this object in bytes

Reimplemented from GemStone::GemFire::Cache::Serializable.

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

Gets the string value.


GemFire C++ Cache .NET API Documentation