Apache Geode Native .NET Reference 1.15.0
Public Member Functions | Static Public Member Functions | Properties
Apache::Geode::Client::CacheableHashSet Class Reference

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

#include <CacheableHashSet.hpp>

Inherits Apache::Geode::Client::Internal::CacheableHashSetType< static_cast< int8_t >(native::private ::DSCode::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...
 
String ^ ToString ()
 Return a string representation of the object. 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...
 

Properties

System::Int32 BucketCount [get]
 Get the number of buckets used by the HashSet. 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
sizethe initial 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
itemThe 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
itemThe 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
arrayThe one-dimensional System.Array that is the destination of the elements copied from CacheableHashSet. The System.Array must have zero-based indexing.
arrayIndexThe zero-based index in array at which copying begins.
Exceptions
IllegalArgumentExceptionarrayIndex is less than 0 or array is null.
OutOfRangeExceptionarrayIndex 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.


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

◆ 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
itemThe 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
sizeThe new size of the HashSet.

◆ 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
otherThe other CacheableHashSet to use for swapping.

◆ ToString() [1/2]

String ^ Apache::Geode::Client::ISerializable::ToString ( )
inherited

Return a string representation of the object.

Implemented in Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)>, Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< NativeArray, NativeArray, ManagedType, DsCode >, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableFileName, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::Properties< String^, String^>, and Apache::Geode::Client::Serializable.

◆ ToString() [2/2]

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

Reimplemented in Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)>, and Apache::Geode::Client::CacheableString.

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.

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

Apache Geode C++ Cache .NET API Documentation