CacheableString Class

Note: This API is now obsolete.

An immutable string wrapper that can serve as a distributable key object for caching as well as being a string value.

Inheritance Hierarchy

SystemObject
  [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::Serializable>]
    GemStone.GemFire.CacheSerializable
      GemStone.GemFire.CacheCacheableKey
        GemStone.GemFire.CacheCacheableString

Namespace: GemStone.GemFire.Cache
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18

Syntax

C++

Copy

[ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public class CacheableString : CacheableKey

<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>
Public Class CacheableString
	Inherits CacheableKey

[ObsoleteAttribute(L"Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public ref class CacheableString : public CacheableKey

[<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>]
type CacheableString =  
    class
        inherit CacheableKey
    end

The CacheableString type exposes the following members.

Constructors

	Name	Description
	CacheableString(Char)	Allocates a new instance copying from the given character array.
	CacheableString(String)	Allocates a new instance copying from the given string.

Top

Properties

	Name	Description
	ClassId	(Overrides SerializableClassId.)
	IsWideString	True when the underlying C string is a wide-character string.
	Length	Gets the length of the underlying C string.
	ObjectSize	return the size of this object in bytes (Overrides SerializableObjectSize.)
	Value	Gets the string value.

Top

Methods

	Name	Description
	Create(Char)	Static function to create a new instance copying from the given character array.
	Create(String)	Static function to create a new instance copying from the given string.
	Equals(Object)	Return true if this key matches other object. It invokes the '==' operator of the underlying gemfire::CacheableString object. (Overrides CacheableKeyEquals(Object).)
	Equals(ICacheableKey)	Return true if this key matches other object. It invokes the '==' operator of the underlying gemfire::CacheableString object. (Overrides CacheableKeyEquals(ICacheableKey).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FromData	Deserializes the managed object -- returns an instance of the IGFSerializable class. (Overrides SerializableFromData(DataInput).)
	GetHashCode	Return the hashcode for this key. (Overrides CacheableKeyGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsNullOrEmpty	Static function to check whether IsNullOrEmpty.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToData	Serializes this managed object. (Overrides SerializableToData(DataOutput).)
	ToString	Return a string representation of the object. This returns the same string as Value property. (Overrides SerializableToString.)

Top

Operators

	Name	Description
	(CacheableString to String)	Implicit conversion operator to underlying System.String.

Top

Reference

GemStone.GemFire.Cache Namespace