Apache::Geode::Client::CacheableHashSet Class Reference

A mutable ICacheableKey hash set wrapper that can serve as a distributable object for caching. More...

Inherits Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >.

Public Member Functions
virtual void	Add (Object^ item)
	Adds an item to the CacheableHashSet. More...
	CacheableHashSet ()
	* Allocates a new empty instance. More...
	CacheableHashSet (System::Int32 size)
	* Allocates a new instance with the given size. More...
virtual void	Clear ()
	Removes all items from the CacheableHashSet. More...
virtual bool	Contains (Object^ item)
	Determines whether the CacheableHashSet contains a specific value. More...
virtual void	CopyTo (array< Object^>^ array, System::Int32 arrayIndex)
	Copies the elements of the CacheableHashSet to an System.Array, starting at a particular System.Array index. More...
virtual IEnumerator< Object^> ^	GetEnumerator ()
	Returns an enumerator that iterates through the CacheableHashSet. More...
virtual bool	Remove (Object^ item)
	Removes the first occurrence of a specific object from the CacheableHashSet. More...
virtual void	Resize (System::Int32 size) sealed
	Increases the bucket count to at least size elements. More...
virtual void	Swap (CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >^ other) sealed
	Swap the contents of this CacheableHashSet with the given one. More...
virtual String ^	ToString () override
	Return a string representation of the object. More...

Static Public Member Functions
static CacheableHashSet ^	Create ()
	* Static function to create a new empty instance. More...
static CacheableHashSet ^	Create (System::Int32 size)
	* Static function to create a new instance with the given size. 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^ (array< Byte >^ value)
	Implicit conversion operator from an array of bytes 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< Double >^ value)
	Implicit conversion operator from a double array 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^ (array< String^>^ value)
	Implicit conversion operator from a string 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^ (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^ (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^ (Char value)
	Implicit conversion operator from a character 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^ (Single value)
	Implicit conversion operator from a float 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^ (System::Int16 value)
	Implicit conversion operator from a 16-bit integer 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 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
System::Int32	BucketCount [get]
	Get the number of buckets used by the HashSet. More...
virtual System::UInt32	ClassId [get]
	Returns the classId of the instance being serialized. More...
virtual System::Int32	Count [get]
	Gets the number of elements contained in the CacheableHashSet. More...
bool	IsEmpty [get]
	True if the CacheableHashSet's size is 0. More...
virtual bool	IsReadOnly [get]
	Gets a value indicating whether the collection is read-only. More...
System::Int32	MaxSize [get]
	Get the largest possible size of the CacheableHashSet. More...

Detailed Description

A mutable ICacheableKey hash set wrapper that can serve as a distributable object for caching.

Constructor & Destructor Documentation

CacheableHashSet() [1/2]

Apache::Geode::Client::CacheableHashSet::CacheableHashSet ( )

inline

* Allocates a new empty instance.

CacheableHashSet() [2/2]

Apache::Geode::Client::CacheableHashSet::CacheableHashSet ( System::Int32  size )

inline

* Allocates a new instance with the given size.

*

Parameters

size	the intial size of the new instance

Member Function Documentation

Add()

virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Add ( Object^  item )

inlinevirtualinherited

Adds an item to the CacheableHashSet.

Parameters

item	The object to add to the collection.

Clear()

virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Clear ( )

inlinevirtualinherited

Removes all items from the CacheableHashSet.

Contains()

virtual bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Contains ( Object^  item )

inlinevirtualinherited

Determines whether the CacheableHashSet contains a specific value.

Parameters

item	The object to locate in the CacheableHashSet.

Returns

true if item is found in the CacheableHashSet; otherwise false.

CopyTo()

virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::CopyTo ( array< Object^>^  array, System::Int32  arrayIndex  )

inlinevirtualinherited

Copies the elements of the CacheableHashSet to an System.Array, starting at a particular System.Array index.

Parameters

array	The one-dimensional System.Array that is the destination of the elements copied from CacheableHashSet. The System.Array must have zero-based indexing.
arrayIndex	The zero-based index in array at which copying begins.

Exceptions

IllegalArgumentException	arrayIndex is less than 0 or array is null.
OutOfRangeException	arrayIndex is equal to or greater than the length of array. -or-The number of elements in the source CacheableHashSet is greater than the available space from arrayIndex to the end of the destination array.

Create() [1/2]

static CacheableHashSet ^ Apache::Geode::Client::CacheableHashSet::Create ( )

inlinestatic

* Static function to create a new empty instance.

Create() [2/2]

static CacheableHashSet ^ Apache::Geode::Client::CacheableHashSet::Create ( System::Int32  size )

inlinestatic

* Static function to create a new instance with the given size.

FromData()

virtual IGeodeSerializable ^ Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::FromData ( DataInput^  input )

inlineoverridevirtualinherited

Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside.

Parameters

input

the DataInput stream to use for reading the object data

Returns

the deserialized object

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

GetEnumerator()

virtual IEnumerator<Object^> ^ Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::GetEnumerator ( )

inlinevirtualinherited

Returns an enumerator that iterates through the CacheableHashSet.

Returns

A System.Collections.Generic.IEnumerator that can be used to iterate through the CacheableHashSet.

operator Apache::Geode::Client::Serializable^() [1/17]

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

staticinherited

Implicit conversion operator from an boolean array to a Serializable.

operator Apache::Geode::Client::Serializable^() [2/17]

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.

operator Apache::Geode::Client::Serializable^() [3/17]

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

staticinherited

Implicit conversion operator from a character array to a Serializable.

operator Apache::Geode::Client::Serializable^() [4/17]

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

staticinherited

Implicit conversion operator from a double array to a Serializable.

operator Apache::Geode::Client::Serializable^() [5/17]

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

staticinherited

Implicit conversion operator from a float array to a Serializable.

operator Apache::Geode::Client::Serializable^() [6/17]

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

staticinherited

Implicit conversion operator from a string array to a Serializable.

operator Apache::Geode::Client::Serializable^() [7/17]

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.

operator Apache::Geode::Client::Serializable^() [8/17]

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.

operator Apache::Geode::Client::Serializable^() [9/17]

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.

operator Apache::Geode::Client::Serializable^() [10/17]

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

staticinherited

Implicit conversion operator from a boolean to a Serializable.

operator Apache::Geode::Client::Serializable^() [11/17]

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

staticinherited

Implicit conversion operator from a byte to a Serializable.

operator Apache::Geode::Client::Serializable^() [12/17]

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

staticinherited

Implicit conversion operator from a character to a Serializable.

operator Apache::Geode::Client::Serializable^() [13/17]

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

staticinherited

Implicit conversion operator from a double to a Serializable.

operator Apache::Geode::Client::Serializable^() [14/17]

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

staticinherited

Implicit conversion operator from a float to a Serializable.

operator Apache::Geode::Client::Serializable^() [15/17]

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

staticinherited

Implicit conversion operator from a string to a Serializable.

operator Apache::Geode::Client::Serializable^() [16/17]

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.

operator Apache::Geode::Client::Serializable^() [17/17]

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.

operator Serializable^()

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

staticinherited

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

RegisterPdxSerializer()

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.

RegisterPdxType()

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

creationMethod

the creation function to register

Exceptions

IllegalArgumentException

if the method is null

RegisterTypeGeneric()

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

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.

Remove()

virtual bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Remove ( Object^  item )

inlinevirtualinherited

Removes the first occurrence of a specific object from the CacheableHashSet.

Parameters

item	The object to remove from the CacheableHashSet.

Returns

true if item was successfully removed from the CacheableHashSet; otherwise, false. This method also returns false if item is not found in the original CacheableHashSet.

Resize()

virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Resize ( System::Int32  size )

inlinesealedvirtualinherited

Increases the bucket count to at least size elements.

Parameters

size	The new size of the HashSet.

SetPdxTypeMapper()

static void Apache::Geode::Client::Serializable::SetPdxTypeMapper ( IPdxTypeMapper^  pdxTypeMapper )

staticinherited

Register an PdxTypeMapper to map the local types to pdx types

Parameters

pdxTypeMapper

Object which implements IPdxTypeMapper interface

Swap()

virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Swap ( CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >^  other )

inlinesealedvirtualinherited

Swap the contents of this CacheableHashSet with the given one.

Parameters

other

The other CacheableHashSet to use for swapping.

ToData()

virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::ToData ( DataOutput^  output )

inlineoverridevirtualinherited

Serializes this native (C++) object.

Parameters

output

the DataOutput object to use for serializing the object

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

ToString()

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

overridevirtualinherited

Return a string representation of the object.

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

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

Reimplemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableFloat, Single, GeodeClassIds::CacheableFloat >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt32, System::Int32, GeodeClassIds::CacheableInt32 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableDouble, Double, GeodeClassIds::CacheableDouble >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableBoolean, bool, GeodeClassIds::CacheableBoolean >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt64, System::Int64, GeodeClassIds::CacheableInt64 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt16, System::Int16, GeodeClassIds::CacheableInt16 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableWideChar, Char, GeodeClassIds::CacheableCharacter >, and Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableByte, Byte, GeodeClassIds::CacheableByte >.

Property Documentation

BucketCount

System:: Int32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::BucketCount

getinherited

Get the number of buckets used by the HashSet.

ClassId

virtual System:: UInt32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::ClassId

getinherited

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

Count

virtual System:: Int32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::Count

getinherited

Gets the number of elements contained in the CacheableHashSet.

IsEmpty

bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::IsEmpty

getinherited

True if the CacheableHashSet's size is 0.

IsReadOnly

virtual bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::IsReadOnly

getinherited

Gets a value indicating whether the collection is read-only.

Returns

always false for CacheableHashSet

MaxSize

System:: Int32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, apache::geode::client::CacheableHashSet >::MaxSize

getinherited

Get the largest possible size of the CacheableHashSet.