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

Inherits GemStone::GemFire::Cache::Generic::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::Generic::ICacheableKey^ other) override
virtual IGFSerializableFromData (DataInput^ input) override
virtual int32_t GetHashCode () override
virtual void ToData (DataOutput^ output) override
virtual String^ ToString () override

Static Public Member Functions

static CacheableStringCreate (array< Char >^value)
static CacheableStringCreate (String^ value)
static bool IsNullOrEmpty (CacheableString^ value)
static operator CacheableKey^ (String^ value)
static operator CacheableKey^ (int64_t value)
static operator CacheableKey^ (int32_t value)
static operator CacheableKey^ (Char value)
static operator CacheableKey^ (int16_t value)
static operator CacheableKey^ (Single value)
static operator CacheableKey^ (Double value)
static operator CacheableKey^ (Byte value)
static operator CacheableKey^ (bool value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< String^ >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (String^ value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< int64_t >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< int32_t >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (int32_t value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< int16_t >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< Char >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (Char value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (int16_t value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< Single >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (Single value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< Double >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (Double value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< bool >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (array< Byte >^value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (Byte value)
static operator GemStone::GemFire::Cache::Generic::Serializable^ (bool value)
static operator Serializable^ (int64_t value)
static operator String^ (CacheableString^ str)
static void RegisterPdxSerializer (IPdxSerializer^ pdxSerializer)
static void RegisterPdxType (PdxTypeFactoryMethod^ creationMethod)
static void RegisterTypeGeneric (TypeFactoryMethodGeneric^ creationMethod)
static void SetPdxTypeMapper (IPdxTypeMapper^ pdxTypeMapper)

Protected Member Functions

void _SetNativePtr (gemfire::Serializable *nativeptr)
void AssignPtr (gemfire::Serializable *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::Serializable *nativeptr)

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::Generic::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::Generic::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

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Serializable >::_SetNativePtr ( gemfire::Serializable *  nativeptr  )  [inline, protected, inherited]

Set the native pointer to the new object without doing a preserveSB(). DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Serializable >::AssignPtr ( gemfire::Serializable *  nativeptr  )  [inline, protected, inherited]

Used to assign the native pointer to a new object.

Note the order of preserveSB() and releaseSB(). This handles the corner case when m_nativeptr is same as nativeptr.

static CacheableString ^ GemStone::GemFire::Cache::Generic::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 CacheableString ^ GemStone::GemFire::Cache::Generic::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::Generic::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::Generic::CacheableKey.

virtual bool GemStone::GemFire::Cache::Generic::CacheableString::Equals ( GemStone::GemFire::Cache::Generic::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::Generic::CacheableKey.

virtual IGFSerializable ^ GemStone::GemFire::Cache::Generic::CacheableString::FromData ( 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::Generic::Serializable.

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

Return the hashcode for this key.

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

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Serializable >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

static bool GemStone::GemFire::Cache::Generic::CacheableString::IsNullOrEmpty ( 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::Generic::CacheableKey::operator CacheableKey^ ( String^   value  )  [static, inherited]

Implicit conversion operator from a string to a CacheableKey.

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

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

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

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

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

Implicit conversion operator from a character to a CacheableKey.

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

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

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

Implicit conversion operator from a float to a CacheableKey.

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

Implicit conversion operator from a double to a CacheableKey.

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

Implicit conversion operator from a byte to a CacheableKey.

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

Implicit conversion operator from a boolean to a CacheableKey.

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

Implicit conversion operator from a string array to a Serializable.

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

Implicit conversion operator from a string to a Serializable.

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

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

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

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

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

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

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

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

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

Implicit conversion operator from a character array to a Serializable.

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

Implicit conversion operator from a character to a Serializable.

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

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

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

Implicit conversion operator from a float array to a Serializable.

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

Implicit conversion operator from a float to a Serializable.

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

Implicit conversion operator from a double array to a Serializable.

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

Implicit conversion operator from a double to a Serializable.

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

Implicit conversion operator from an boolean array to a Serializable.

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

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

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

Implicit conversion operator from a byte to a Serializable.

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

Implicit conversion operator from a boolean to a Serializable.

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

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

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

Implicit conversion operator to underlying System.String.

static void GemStone::GemFire::Cache::Generic::Serializable::RegisterPdxSerializer ( IPdxSerializer^   pdxSerializer  )  [static, inherited]

Set the PDX serializer for the cache. If this serializer is set, it will be consulted to see if it can serialize any domain classes which are added to the cache in portable data exchange format.

static void GemStone::GemFire::Cache::Generic::Serializable::RegisterPdxType ( PdxTypeFactoryMethod^   creationMethod  )  [static, inherited]

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

Parameters:
creationMethod the creation function to register
Exceptions:
IllegalArgumentException if the method is null

static void GemStone::GemFire::Cache::Generic::Serializable::RegisterTypeGeneric ( TypeFactoryMethodGeneric^   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.

static void GemStone::GemFire::Cache::Generic::Serializable::SetPdxTypeMapper ( IPdxTypeMapper^   pdxTypeMapper  )  [static, inherited]

Register an PdxTypeMapper to map the local types to pdx types

Parameters:
pdxTypeMapper Object which implements IPdxTypeMapper interface

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Serializable >::SetPtr ( gemfire::Serializable *  nativeptr  )  [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL.

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

Serializes this managed object.

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

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

virtual String ^ GemStone::GemFire::Cache::Generic::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::Generic::Serializable.


Property Documentation

virtual uint32_t GemStone::GemFire::Cache::Generic::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::Generic::Serializable.

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

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

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

Gets the length of the underlying C string.

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

return the size of this object in bytes

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

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

Gets the string value.


GemFire C++ Cache .NET API Documentation