GemStone::GemFire::Cache::CacheableHashSet Class Reference

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


Detailed Description

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

Public Member Functions

virtual void Add (ICacheableKey^ item)
 CacheableHashSet (size_t size)
 CacheableHashSet ()
virtual void Clear ()
virtual Boolean Contains (ICacheableKey^ item)
virtual void CopyTo (array< ICacheableKey^ >^array, Int32 arrayIndex)
virtual IGFSerializableFromData (DataInput^ input)
virtual IEnumerator
< ICacheableKey^ >^ 
GetEnumerator ()
virtual Boolean Remove (ICacheableKey^ item)
void Resize (size_t size)
void Swap (CacheableHashSet^ other)
virtual void ToData (DataOutput^ output)
virtual String^ ToString () override

Static Public Member Functions

static operator Serializable^ (array< String^ >^value)
static operator Serializable^ (String^ value)
static operator Serializable^ (array< Int64 >^value)
static operator Serializable^ (Int64 value)
static operator Serializable^ (array< Int32 >^value)
static operator Serializable^ (Int32 value)
static operator Serializable^ (array< Int16 >^value)
static operator Serializable^ (Char value)
static operator Serializable^ (Int16 value)
static operator Serializable^ (array< Single >^value)
static operator Serializable^ (Single value)
static operator Serializable^ (array< Double >^value)
static operator Serializable^ (Double value)
static operator Serializable^ (array< Byte >^value)
static operator Serializable^ (Byte value)
static operator Serializable^ (Boolean value)
static void RegisterType (TypeFactoryMethod^ creationMethod)

Properties

size_t BucketCount [get]
virtual Byte ClassId [get]
virtual Int32 Count [get]
Boolean IsEmpty [get]
virtual Boolean IsReadOnly [get]
size_t MaxLength [get]
virtual UInt32 ObjectSize [get]

Data Structures

class  Enumerator

Constructor & Destructor Documentation

GemStone::GemFire::Cache::CacheableHashSet::CacheableHashSet (  )  [inline]

Allocates a new empty instance.

GemStone::GemFire::Cache::CacheableHashSet::CacheableHashSet ( size_t  size  )  [inline]

Allocates a new empty instance with given initial size.

Parameters:
size The initial size of the HashSet.


Member Function Documentation

virtual void GemStone::GemFire::Cache::CacheableHashSet::Add ( ICacheableKey^   item  )  [virtual]

Adds an item to the CacheableHashSet.

Parameters:
item The object to add to the collection.

virtual void GemStone::GemFire::Cache::CacheableHashSet::Clear (  )  [virtual]

Removes all items from the CacheableHashSet.

virtual Boolean GemStone::GemFire::Cache::CacheableHashSet::Contains ( ICacheableKey^   item  )  [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.

virtual void GemStone::GemFire::Cache::CacheableHashSet::CopyTo ( array< ICacheableKey^ >^  array,
Int32  arrayIndex 
) [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.

virtual IGFSerializable ^ GemStone::GemFire::Cache::Serializable::FromData ( DataInput^   input  )  [virtual, inherited]

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

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

virtual IEnumerator<ICacheableKey^> ^ GemStone::GemFire::Cache::CacheableHashSet::GetEnumerator (  )  [virtual]

Returns an enumerator that iterates through the CacheableHashSet.

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

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

Implicit conversion operator from a string array to a Serializable.

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

Implicit conversion operator from a string to a Serializable.

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

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

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

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

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

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

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

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

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

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

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

Implicit conversion operator from a character to a Serializable.

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

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

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

Implicit conversion operator from a float array to a Serializable.

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

Implicit conversion operator from a float to a Serializable.

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

Implicit conversion operator from a double array to a Serializable.

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

Implicit conversion operator from a double to a Serializable.

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

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

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

Implicit conversion operator from a byte to a Serializable.

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

Implicit conversion operator from a boolean to a Serializable.

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 Boolean GemStone::GemFire::Cache::CacheableHashSet::Remove ( ICacheableKey^   item  )  [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.

void GemStone::GemFire::Cache::CacheableHashSet::Resize ( size_t  size  ) 

Increases the bucket count to at least size elements.

Parameters:
size The new size of the HashSet.

void GemStone::GemFire::Cache::CacheableHashSet::Swap ( CacheableHashSet^   other  ) 

Swap the contents of this CacheableHashSet with the given one.

Parameters:
other The other CacheableHashSet to use for swapping.

virtual void GemStone::GemFire::Cache::Serializable::ToData ( DataOutput^   output  )  [virtual, inherited]

Serializes this native (C++) object.

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

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

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

Reimplemented in GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::CacheableString, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireClassIds::CacheableFloat >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt64, Int64, GemFireClassIds::CacheableInt64 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireClassIds::CacheableByte >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireClassIds::CacheableCharacter >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt16, Int16, GemFireClassIds::CacheableInt16 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireClassIds::CacheableDouble >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt32, Int32, GemFireClassIds::CacheableInt32 >, and GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableBoolean, Boolean, GemFireClassIds::CacheableBoolean >.


Property Documentation

size_t GemStone::GemFire::Cache::CacheableHashSet::BucketCount [get]

Get the number of buckets used by the HashSet.

virtual Byte GemStone::GemFire::Cache::CacheableHashSet::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.

virtual Int32 GemStone::GemFire::Cache::CacheableHashSet::Count [get]

Gets the number of elements contained in the CacheableHashSet.

Boolean GemStone::GemFire::Cache::CacheableHashSet::IsEmpty [get]

True if the CacheableHashSet's size is 0.

virtual Boolean GemStone::GemFire::Cache::CacheableHashSet::IsReadOnly [get]

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

Returns:
always false for CacheableHashSet

size_t GemStone::GemFire::Cache::CacheableHashSet::MaxLength [get]

Get the largest possible size of the CacheableHashSet.

virtual UInt32 GemStone::GemFire::Cache::Serializable::ObjectSize [get, inherited]

return the size of this object in bytes

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


GemFire C++ Cache .NET API Documentation