VMware GemFire Native Client .NET Framework API Reference
|
VMware VMware GemFire Native .NET Reference 10.4.3
|
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. | |
| virtual void | Clear () |
Removes all items from the CacheableHashSet. | |
| virtual bool | Contains (Object^ item) |
Determines whether the CacheableHashSet contains a specific value. | |
| 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. | |
| virtual IEnumerator< Object^> ^ | GetEnumerator () |
Returns an enumerator that iterates through the CacheableHashSet. | |
| virtual bool | Remove (Object^ item) |
Removes the first occurrence of a specific object from the CacheableHashSet. | |
| virtual void | Resize (System::Int32 size) sealed |
Increases the bucket count to at least size elements. | |
| virtual void | Swap (CacheableHashSetType< TYPEID, HSTYPE >^ other) sealed |
Swap the contents of this CacheableHashSet with the given one. | |
| String ^ | ToString () |
| Return a string representation of the object. | |
| virtual String ^ | ToString () override |
| Return a string representation of the object. | |
Protected Member Functions | |
| CacheableHashSetType () | |
| Allocates a new empty instance. | |
| CacheableHashSetType (std::shared_ptr< apache::geode::client::Serializable > nativeptr) | |
| Private constructor to wrap a native object pointer. | |
| CacheableHashSetType (System::Int32 size) | |
| Allocates a new empty instance with given initial size. | |
Properties | |
| System::Int32 | BucketCount [get] |
| Get the number of buckets used by the HashSet. | |
| virtual System::Int32 | Count [get] |
Gets the number of elements contained in the CacheableHashSet. | |
| bool | IsEmpty [get] |
True if the CacheableHashSet's size is 0. | |
| virtual bool | IsReadOnly [get] |
| Gets a value indicating whether the collection is read-only. | |
| System::Int32 | MaxSize [get] |
Get the largest possible size of the CacheableHashSet. | |
Detailed Description
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]
|
inlineprotected |
Private constructor to wrap a native object pointer.
- Parameters
-
nativeptr The native object pointer
◆ CacheableHashSetType() [2/3]
|
inlineprotected |
Allocates a new empty instance.
◆ CacheableHashSetType() [3/3]
|
inlineprotected |
Allocates a new empty instance with given initial size.
- Parameters
-
size The initial size of the HashSet.
Member Function Documentation
◆ Add()
|
inlinevirtual |
Adds an item to the CacheableHashSet.
- Parameters
-
item The object to add to the collection.
◆ Clear()
|
inlinevirtual |
Removes all items from the CacheableHashSet.
◆ Contains()
|
inlinevirtual |
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()
|
inlinevirtual |
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. TheSystem.Arraymust 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 CacheableHashSetis greater than the available space from arrayIndex to the end of the destination array.
◆ GetEnumerator()
|
inlinevirtual |
Returns an enumerator that iterates through the CacheableHashSet.
- Returns
- A
System.Collections.Generic.IEnumeratorthat can be used to iterate through theCacheableHashSet.
◆ Remove()
|
inlinevirtual |
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 originalCacheableHashSet.
◆ Resize()
|
inlinesealedvirtual |
Increases the bucket count to at least size elements.
- Parameters
-
size The new size of the HashSet.
◆ Swap()
|
inlinesealedvirtual |
Swap the contents of this CacheableHashSet with the given one.
- Parameters
-
other The other CacheableHashSet to use for swapping.
◆ ToString() [1/2]
|
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]
|
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
|
get |
Get the number of buckets used by the HashSet.
◆ Count
|
get |
Gets the number of elements contained in the CacheableHashSet.
◆ IsEmpty
|
get |
True if the CacheableHashSet's size is 0.
◆ IsReadOnly
|
get |
Gets a value indicating whether the collection is read-only.
- Returns
- always false for
CacheableHashSet
◆ MaxSize
|
get |
Get the largest possible size of the CacheableHashSet.
Apache Geode C++ Cache .NET API Documentation