VMware GemFire Native .NET Reference  9.1
Apache::Geode::Client::CacheableStringArray Class Reference

An immutable wrapper for array of strings that can serve as a distributable object for caching. More...

Inherits Apache::Geode::Client::Serializable.

Public Member Functions

virtual IGeodeSerializableFromData (DataInput^ input) override
 Deserializes the managed object – returns an instance of the IGeodeSerializable class. More...
 
array< String^ >^ GetValues ()
 Returns a copy of the underlying array of strings. More...
 
virtual void ToData (DataOutput^ output) override
 Serializes this managed object. More...
 
virtual String^ ToString () override
 Return a string representation of the object. More...
 

Static Public Member Functions

static CacheableStringArrayCreate (array< String^ >^strings)
 Static function to create a new instance copying from the given string array. More...
 
static IGeodeSerializableCreateDeserializable ()
 Factory function to register this class. More...
 
static operator Apache::Geode::Client::Serializable^ (bool value)
 Implicit conversion operator from a boolean to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Byte value)
 Implicit conversion operator from a byte to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Byte >^value)
 Implicit conversion operator from an array of bytes to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< bool >^value)
 Implicit conversion operator from an boolean array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Double value)
 Implicit conversion operator from a double to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Double >^value)
 Implicit conversion operator from a double array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Single value)
 Implicit conversion operator from a float to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Single >^value)
 Implicit conversion operator from a float array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (System::Int16 value)
 Implicit conversion operator from a 16-bit integer to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Char value)
 Implicit conversion operator from a character to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Char >^value)
 Implicit conversion operator from a character array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< System::Int16 >^value)
 Implicit conversion operator from a 16-bit integer array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (System::Int32 value)
 Implicit conversion operator from a 32-bit integer to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< System::Int32 >^value)
 Implicit conversion operator from a 32-bit integer array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< System::Int64 >^value)
 Implicit conversion operator from a 64-bit integer array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (String^ value)
 Implicit conversion operator from a string to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< String^ >^value)
 Implicit conversion operator from a string array to a Serializable. More...
 
static operator Serializable^ (System::Int64 value)
 Implicit conversion operator from a 64-bit integer to a Serializable. More...
 
static void RegisterPdxSerializer (IPdxSerializer^ pdxSerializer)
 Set the PDX serializer for the cache. More...
 
static void RegisterPdxType (PdxTypeFactoryMethod^ creationMethod)
 
static void RegisterTypeGeneric (TypeFactoryMethodGeneric^ creationMethod)
 Register an instance factory method for a given type. More...
 
static void SetPdxTypeMapper (IPdxTypeMapper^ pdxTypeMapper)
 Register an PdxTypeMapper to map the local types to pdx types More...
 

Properties

virtual System::UInt32 ClassId [get]
 Returns the classId of the instance being serialized. More...
 
String^  Item [get]
 Returns a copy of the underlying string at the given index. More...
 
System::Int32 Length [get]
 Gets the length of the array. More...
 
virtual System::UInt32 ObjectSize [get]
 return the size of this object in bytes More...
 

Detailed Description

An immutable wrapper for array of strings that can serve as a distributable object for caching.

Member Function Documentation

static CacheableStringArray ^ Apache::Geode::Client::CacheableStringArray::Create ( array< String^ >^  strings)
inlinestatic

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

If the given array of strings is null or of zero-length then this method returns null.

Exceptions
IllegalArgumentExceptionIf the array contains a string greater than or equal 64K in length.
static IGeodeSerializable ^ Apache::Geode::Client::CacheableStringArray::CreateDeserializable ( )
inlinestatic

Factory function to register this class.

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

Deserializes the managed object – returns an instance of the IGeodeSerializable class.

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

Reimplemented from Apache::Geode::Client::Serializable.

array<String^> ^ Apache::Geode::Client::CacheableStringArray::GetValues ( )

Returns a copy of the underlying array of strings.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( bool  value)
staticinherited

Implicit conversion operator from a boolean to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Byte  value)
staticinherited

Implicit conversion operator from a byte to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Byte >^  value)
staticinherited

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

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< bool >^  value)
staticinherited

Implicit conversion operator from an boolean array to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Double  value)
staticinherited

Implicit conversion operator from a double to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Double >^  value)
staticinherited

Implicit conversion operator from a double array to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Single  value)
staticinherited

Implicit conversion operator from a float to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Single >^  value)
staticinherited

Implicit conversion operator from a float array to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int16  value)
staticinherited

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

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Char  value)
staticinherited

Implicit conversion operator from a character to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Char >^  value)
staticinherited

Implicit conversion operator from a character array to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int16 >^  value)
staticinherited

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

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int32  value)
staticinherited

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

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int32 >^  value)
staticinherited

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

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int64 >^  value)
staticinherited

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

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( String^  value)
staticinherited

Implicit conversion operator from a string to a Serializable.

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< String^ >^  value)
staticinherited

Implicit conversion operator from a string array to a Serializable.

static Apache::Geode::Client::Serializable::operator Serializable^ ( System::Int64  value)
staticinherited

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

static void Apache::Geode::Client::Serializable::RegisterPdxSerializer ( IPdxSerializer pdxSerializer)
staticinherited

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 Apache::Geode::Client::Serializable::RegisterPdxType ( PdxTypeFactoryMethod creationMethod)
staticinherited

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

Parameters
creationMethodthe creation function to register
Exceptions
IllegalArgumentExceptionif the method is null
static void Apache::Geode::Client::Serializable::RegisterTypeGeneric ( TypeFactoryMethodGeneric creationMethod)
staticinherited

Register an instance factory method for a given type.

This should be used when registering types that implement IGeodeSerializable.

Parameters
creationMethodthe creation function to register
Exceptions
IllegalArgumentExceptionif the method is null
IllegalStateExceptionif 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 Apache::Geode::Client::Serializable::SetPdxTypeMapper ( IPdxTypeMapper pdxTypeMapper)
staticinherited

Register an PdxTypeMapper to map the local types to pdx types

Parameters
pdxTypeMapperObject which implements IPdxTypeMapper interface
virtual void Apache::Geode::Client::CacheableStringArray::ToData ( DataOutput output)
overridevirtual

Serializes this managed object.

Parameters
outputthe DataOutput object to use for serializing the object

Reimplemented from Apache::Geode::Client::Serializable.

virtual String ^ Apache::Geode::Client::CacheableStringArray::ToString ( )
inlineoverridevirtual

Return a string representation of the object.

It simply returns the string representation of the underlying native object by calling its toString() function.

Reimplemented from Apache::Geode::Client::Serializable.

Property Documentation

virtual System:: UInt32 Apache::Geode::Client::CacheableStringArray::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
String^ Apache::Geode::Client::CacheableStringArray::Item
get

Returns a copy of the underlying string at the given index.

System:: Int32 Apache::Geode::Client::CacheableStringArray::Length
get

Gets the length of the array.

virtual System:: UInt32 Apache::Geode::Client::CacheableStringArray::ObjectSize
get

return the size of this object in bytes


Pivotal GemFire .NET Cache API Documentation