Apache Geode Native .NET Reference 1.15.0
Data Structures | Public Member Functions | Protected Member Functions | Properties
Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE > Class Template Reference

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

#include <CacheableHashSet.hpp>

Inherits Apache::Geode::Client::IDataSerializablePrimitive, Apache::Geode::Client::Serializable, and ICollection< Object^>.

Data Structures

class  Enumerator
 Enumerator for CacheableHashSet class. More...
 

Public Member Functions

virtual void Add (Object^ item)
 Adds an item to the CacheableHashSet. 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, HSTYPE >^ 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...
 

Protected Member Functions

 CacheableHashSetType ()
 Allocates a new empty instance. More...
 
 CacheableHashSetType (std::shared_ptr< apache::geode::client::Serializable > nativeptr)
 Private constructor to wrap a native object pointer More...
 
 CacheableHashSetType (System::Int32 size)
 Allocates a new empty instance with given initial 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

template<int8_t TYPEID, typename HSTYPE>
class Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >

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

Constructor & Destructor Documentation

◆ CacheableHashSetType() [1/3]

template<int8_t TYPEID, typename HSTYPE >
Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::CacheableHashSetType ( std::shared_ptr< apache::geode::client::Serializable >  nativeptr)
inlineprotected

Private constructor to wrap a native object pointer

Parameters
nativeptrThe native object pointer

◆ CacheableHashSetType() [2/3]

template<int8_t TYPEID, typename HSTYPE >
Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::CacheableHashSetType ( )
inlineprotected

Allocates a new empty instance.

◆ CacheableHashSetType() [3/3]

template<int8_t TYPEID, typename HSTYPE >
Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::CacheableHashSetType ( System::Int32  size)
inlineprotected

Allocates a new empty instance with given initial size.

Parameters
sizeThe initial size of the HashSet.

Member Function Documentation

◆ Add()

template<int8_t TYPEID, typename HSTYPE >
virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Add ( Object^  item)
inlinevirtual

Adds an item to the CacheableHashSet.

Parameters
itemThe object to add to the collection.

◆ Clear()

template<int8_t TYPEID, typename HSTYPE >
virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Clear ( )
inlinevirtual

Removes all items from the CacheableHashSet.

◆ Contains()

template<int8_t TYPEID, typename HSTYPE >
virtual bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Contains ( Object^  item)
inlinevirtual

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()

template<int8_t TYPEID, typename HSTYPE >
virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::CopyTo ( array< Object^>^  array,
System::Int32  arrayIndex 
)
inlinevirtual

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.

◆ GetEnumerator()

template<int8_t TYPEID, typename HSTYPE >
virtual IEnumerator< Object^> ^ Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::GetEnumerator ( )
inlinevirtual

Returns an enumerator that iterates through the CacheableHashSet.

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

◆ Remove()

template<int8_t TYPEID, typename HSTYPE >
virtual bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Remove ( Object^  item)
inlinevirtual

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()

template<int8_t TYPEID, typename HSTYPE >
virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Resize ( System::Int32  size)
inlinesealedvirtual

Increases the bucket count to at least size elements.

Parameters
sizeThe new size of the HashSet.

◆ Swap()

template<int8_t TYPEID, typename HSTYPE >
virtual void Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Swap ( CacheableHashSetType< TYPEID, HSTYPE >^  other)
inlinesealedvirtual

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

template<int8_t TYPEID, typename HSTYPE >
System:: Int32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::BucketCount
get

Get the number of buckets used by the HashSet.

◆ Count

template<int8_t TYPEID, typename HSTYPE >
virtual System:: Int32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::Count
get

Gets the number of elements contained in the CacheableHashSet.

◆ IsEmpty

template<int8_t TYPEID, typename HSTYPE >
bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::IsEmpty
get

True if the CacheableHashSet's size is 0.

◆ IsReadOnly

template<int8_t TYPEID, typename HSTYPE >
virtual bool Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::IsReadOnly
get

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

Returns
always false for CacheableHashSet

◆ MaxSize

template<int8_t TYPEID, typename HSTYPE >
System:: Int32 Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >::MaxSize
get

Get the largest possible size of the CacheableHashSet.

Apache Geode C++ Cache .NET API Documentation