VMware Tanzu GemFire .NET Client API Reference

VMware Tanzu GemFire .NET Client: ICacheableKey Interface Reference
VMware Tanzu GemFire .NET Client
Public Member Functions | List of all members
ICacheableKey Interface Reference

This interface class is the superclass of all user objects in the cache that can be used as a key. More...

Inheritance diagram for ICacheableKey:
ISerializable

Public Member Functions

bool Equals (object obj)
 Returns true if this ICacheableKey matches the other. More...
 
int GetHashCode ()
 Get the hash code for this object. This is used in the internal hash tables and so must have a nice distribution pattern. More...
 
string ToString ()
 Stringifys the object More...
 

Detailed Description

This interface class is the superclass of all user objects in the cache that can be used as a key.

If an implementation is required to act as a key in the cache, then it must implement this interface and preferably override System.Object.ToString to obtain proper string representation. Note that this interface requires that the class overrides Object.GetHashCode. Though this is not enforced, the default implementation in System.Object is almost certainly incorrect and will not work correctly.

Member Function Documentation

◆ Equals()

bool ICacheableKey.Equals ( object  obj)

Returns true if this ICacheableKey matches the other.

◆ GetHashCode()

int ICacheableKey.GetHashCode ( )

Get the hash code for this object. This is used in the internal hash tables and so must have a nice distribution pattern.

Returns
The hashcode for this object.

◆ ToString()

string ICacheableKey.ToString ( )

Stringifys the object

Returns
Stringification of object
The documentation for this interface was generated from the following file:
  • gemfire.client/Interfaces/ICacheableKey.cs