GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE > Class Template Reference

Inherits GemStone::GemFire::Cache::Generic::Serializable.


Detailed Description

template<uint32_t TYPEID, typename HSTYPE>
class GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >

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

Public Member Functions

virtual void Add (Object^ item)
virtual void Clear ()
virtual bool Contains (Object^ item)
virtual void CopyTo (array< Object^ >^array, int32_t arrayIndex)
virtual IGFSerializableFromData (DataInput^ input) override
virtual IEnumerator
< Object^ >^ 
GetEnumerator ()
virtual bool Remove (Object^ item)
virtual void Resize (int32_t size) sealed
virtual void Swap (CacheableHashSetType< TYPEID, HSTYPE >^other) sealed
virtual void ToData (DataOutput^ output) override
virtual String^ ToString () override

Static Public Member Functions

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 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)
 C (int32_t size)
 C ()
 C (gemfire::Serializable *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::Serializable *nativeptr)

Properties

int32_t BucketCount [get]
virtual uint32_t ClassId [get]
virtual int32_t Count [get]
bool IsEmpty [get]
virtual bool IsReadOnly [get]
int32_t MaxSize [get]
virtual uint32_t ObjectSize [get]

Data Structures

class  Enumerator

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.

template<uint32_t TYPEID, typename HSTYPE>
virtual void GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Add ( Object^   item  )  [inline, virtual]

Adds an item to the CacheableHashSet.

Parameters:
item The object to add to the collection.

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.

template<uint32_t TYPEID, typename HSTYPE>
GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::C ( int32_t  size  )  [inline, protected]

Allocates a new empty instance with given initial size.

Parameters:
size The initial size of the HashSet.

template<uint32_t TYPEID, typename HSTYPE>
GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::C (  )  [inline, protected]

Allocates a new empty instance.

template<uint32_t TYPEID, typename HSTYPE>
GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::C ( gemfire::Serializable *  nativeptr  )  [inline, protected]

Private constructor to wrap a native object pointer

Parameters:
nativeptr The native object pointer

template<uint32_t TYPEID, typename HSTYPE>
virtual void GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Clear (  )  [inline, virtual]

Removes all items from the CacheableHashSet.

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

template<uint32_t TYPEID, typename HSTYPE>
virtual bool GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Contains ( Object^   item  )  [inline, virtual]

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.

template<uint32_t TYPEID, typename HSTYPE>
virtual void GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::CopyTo ( array< Object^ >^  array,
int32_t  arrayIndex 
) [inline, virtual]

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.

template<uint32_t TYPEID, typename HSTYPE>
virtual IGFSerializable ^ GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::FromData ( DataInput^   input  )  [inline, override, virtual]

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

template<uint32_t TYPEID, typename HSTYPE>
virtual IEnumerator<Object^> ^ GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::GetEnumerator (  )  [inline, virtual]

Returns an enumerator that iterates through the CacheableHashSet.

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

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

Internal cleanup function invoked by dispose/finalizer.

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 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.

template<uint32_t TYPEID, typename HSTYPE>
virtual bool GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Remove ( Object^   item  )  [inline, virtual]

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.

template<uint32_t TYPEID, typename HSTYPE>
virtual void GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Resize ( int32_t  size  )  [inline, sealed, virtual]

Increases the bucket count to at least size elements.

Parameters:
size The new size of the HashSet.

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.

template<uint32_t TYPEID, typename HSTYPE>
virtual void GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Swap ( CacheableHashSetType< TYPEID, HSTYPE >^  other  )  [inline, sealed, virtual]

Swap the contents of this CacheableHashSet with the given one.

Parameters:
other The other CacheableHashSet to use for swapping.

template<uint32_t TYPEID, typename HSTYPE>
virtual void GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::ToData ( DataOutput^   output  )  [inline, override, virtual]

Serializes this native (C++) 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::Serializable::ToString (  )  [override, virtual, inherited]

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

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

Reimplemented in GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, GemStone::GemFire::Cache::Generic::CacheableStringArray, GemStone::GemFire::Cache::Generic::CacheableString, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireClassIds::CacheableFloat >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireClassIds::CacheableByte >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireClassIds::CacheableCharacter >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireClassIds::CacheableDouble >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableInt64, int64_t, GemFireClassIds::CacheableInt64 >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableBoolean, bool, GemFireClassIds::CacheableBoolean >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableInt16, int16_t, GemFireClassIds::CacheableInt16 >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableInt32, int32_t, GemFireClassIds::CacheableInt32 >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableBytes, gemfire::CacheableBytesPtr, Byte, GemFireClassIds::CacheableBytes >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableInt32Array, gemfire::CacheableInt32ArrayPtr, int32_t, GemFireClassIds::CacheableInt32Array >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CharArray, gemfire::CharArrayPtr, Char, GemFireClassIds::CharArray >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableInt64Array, gemfire::CacheableInt64ArrayPtr, int64_t, GemFireClassIds::CacheableInt64Array >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableFloatArray, gemfire::CacheableFloatArrayPtr, Single, GemFireClassIds::CacheableFloatArray >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableInt16Array, gemfire::CacheableInt16ArrayPtr, int16_t, GemFireClassIds::CacheableInt16Array >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableDoubleArray, gemfire::CacheableDoubleArrayPtr, Double, GemFireClassIds::CacheableDoubleArray >, and GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::BooleanArray, gemfire::BooleanArrayPtr, bool, GemFireClassIds::BooleanArray >.


Property Documentation

template<uint32_t TYPEID, typename HSTYPE>
int32_t GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::BucketCount [get]

Get the number of buckets used by the HashSet.

template<uint32_t TYPEID, typename HSTYPE>
virtual uint32_t GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::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.

template<uint32_t TYPEID, typename HSTYPE>
virtual int32_t GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Count [get]

Gets the number of elements contained in the CacheableHashSet.

template<uint32_t TYPEID, typename HSTYPE>
bool GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::IsEmpty [get]

True if the CacheableHashSet's size is 0.

template<uint32_t TYPEID, typename HSTYPE>
virtual bool GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::IsReadOnly [get]

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

Returns:
always false for CacheableHashSet

template<uint32_t TYPEID, typename HSTYPE>
int32_t GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::MaxSize [get]

Get the largest possible size of the CacheableHashSet.

template<uint32_t TYPEID, typename HSTYPE>
virtual uint32_t GemStone::GemFire::Cache::Generic::Internal::CacheableHashSetType< TYPEID, HSTYPE >::ObjectSize [get]

return the size of this object in bytes

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


GemFire C++ Cache .NET API Documentation