GemStone::GemFire::Cache::Properties Class Reference

Inherits GemStone::GemFire::Cache::IGFSerializable.

---

Detailed Description

Provides a collection of properties, each of which is a key/value pair. Each key is a string, and the value may be a string or an integer.

Public Member Functions
void	AddAll (Properties^ other)
IGFSerializable^	Find (CacheableKey^ key)
IGFSerializable^	Find (GemStone::GemFire::Cache::ICacheableKey^ key)
String^	Find (String^ key)
void	ForEach (PropertyVisitor^ visitor)
virtual IGFSerializable^	FromData (DataInput^ input)
void	Insert (CacheableKey^ key, GemStone::GemFire::Cache::Serializable^ value)
void	Insert (GemStone::GemFire::Cache::ICacheableKey^ key, GemStone::GemFire::Cache::Serializable^ value)
void	Insert (CacheableKey^ key, IGFSerializable^ value)
void	Insert (GemStone::GemFire::Cache::ICacheableKey^ key, IGFSerializable^ value)
void	Insert (String^ key, int32_t value)
void	Insert (String^ key, String^ value)
void	Load (String^ fileName)
	Properties ()
void	Remove (CacheableKey^ key)
void	Remove (GemStone::GemFire::Cache::ICacheableKey^ key)
void	Remove (String^ key)
virtual void	ToData (DataOutput^ output)
virtual String^	ToString () override
Static Public Member Functions
static Properties^	Create ()
static Properties^	CreateFromVoidPtr (void *ptr)
Properties
virtual uint32_t	ClassId [get]
void *	NativeIntPtr [get]
virtual uint32_t	ObjectSize [get]
uint32_t	Size [get]

---

Constructor & Destructor Documentation

GemStone::GemFire::Cache::Properties::Properties

(

)

[inline]

Default constructor: returns an empty collection.

---

Member Function Documentation

void GemStone::GemFire::Cache::Properties::AddAll

(

Properties^

other

)

Adds the contents of other to this instance, replacing any existing values with those from other.

Parameters:

other

new set of properties

static Properties ^ GemStone::GemFire::Cache::Properties::Create

(

)

[inline, static]

Factory method to create an empty collection of properties.

Returns:

empty collection of properties

static Properties ^ GemStone::GemFire::Cache::Properties::CreateFromVoidPtr

(

void *

ptr

)

[inline, static]

Internal factory function to wrap a native object pointer inside this managed class with null pointer check.

Parameters:

ptr

The native IntPtr pointer

Returns:

The managed wrapper object; null if the native pointer is null.

IGFSerializable ^ GemStone::GemFire::Cache::Properties::Find

(

CacheableKey^

key

)

Return the value for the given CacheableKey, or NULL if not found.

Parameters:

key

the key to find

Returns:

the serializable value for the key

Exceptions:

NullPointerException

if the key is null

IGFSerializable ^ GemStone::GemFire::Cache::Properties::Find

(

GemStone::GemFire::Cache::ICacheableKey^

key

)

Return the value for the given ICacheableKey, or NULL if not found.

Parameters:

key

the key to find

Returns:

the serializable value for the key

Exceptions:

NullPointerException

if the key is null

String ^ GemStone::GemFire::Cache::Properties::Find

(

String^

key

)

Return the value for the given key, or NULL if not found.

Parameters:

key

the key to find

Returns:

the value for the key

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::ForEach

(

PropertyVisitor^

visitor

)

Execute the Visitor delegate for each entry in the collection.

Parameters:

visitor

visitor delegate

virtual IGFSerializable ^ GemStone::GemFire::Cache::Properties::FromData

(

DataInput^

input

)

[virtual]

Deserializes this Properties object.

Parameters:

input

the DataInput stream to use for reading data

Returns:

the deserialized Properties object

Implements GemStone::GemFire::Cache::IGFSerializable.

void GemStone::GemFire::Cache::Properties::Insert	(	CacheableKey^	key,
		GemStone::GemFire::Cache::Serializable^	value
	)

Add or update Serializable value for CacheableKey.

Parameters:

	key	the key to insert
	value	the Serializable value to insert

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Insert	(	GemStone::GemFire::Cache::ICacheableKey^	key,
		GemStone::GemFire::Cache::Serializable^	value
	)

Add or update Serializable value for ICacheableKey.

Parameters:

	key	the key to insert
	value	the Serializable value to insert

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Insert	(	CacheableKey^	key,
		IGFSerializable^	value
	)

Add or update IGFSerializable value for CacheableKey.

Parameters:

	key	the key to insert
	value	the IGFSerializable value to insert

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Insert	(	GemStone::GemFire::Cache::ICacheableKey^	key,
		IGFSerializable^	value
	)

Add or update IGFSerializable value for ICacheableKey.

Parameters:

	key	the key to insert
	value	the IGFSerializable value to insert

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Insert	(	String^	key,
		int32_t	value
	)

Add or update the int value for key.

Parameters:

	key	the key to insert
	value	the integer value to insert

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Insert	(	String^	key,
		String^	value
	)

Add or update the string value for key.

Parameters:

	key	the key to insert
	value	the string value to insert

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Load

(

String^

fileName

)

Reads property values from a file, overriding what is currently in the properties object.

Parameters:

fileName

the name of the file

void GemStone::GemFire::Cache::Properties::Remove

(

CacheableKey^

key

)

Remove the given CacheableKey from the collection.

Parameters:

key

the key to remove

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Remove

(

GemStone::GemFire::Cache::ICacheableKey^

key

)

Remove the given ICacheableKey from the collection.

Parameters:

key

the key to remove

Exceptions:

NullPointerException

if the key is null

void GemStone::GemFire::Cache::Properties::Remove

(

String^

key

)

Remove the key from the collection.

Parameters:

key

the key to remove

Exceptions:

NullPointerException

if the key is null

virtual void GemStone::GemFire::Cache::Properties::ToData

(

DataOutput^

output

)

[virtual]

Serializes this Properties object.

Parameters:

output

the DataOutput stream to use for serialization

Implements GemStone::GemFire::Cache::IGFSerializable.

virtual String ^ GemStone::GemFire::Cache::Properties::ToString

(

)

[override, virtual]

Returns a string representation of the current Properties object.

Returns:

A comma separated list of property name,value pairs.

Implements GemStone::GemFire::Cache::IGFSerializable.

---

Property Documentation

virtual uint32_t GemStone::GemFire::Cache::Properties::ClassId [get]

Returns the classId of this class for serialization.

Returns:

classId of the Properties class

See also:

IGFSerializable.ClassId

Implements GemStone::GemFire::Cache::IGFSerializable.

void* GemStone::GemFire::Cache::Properties::NativeIntPtr [get]

Get the underlying native unmanaged pointer.

virtual uint32_t GemStone::GemFire::Cache::Properties::ObjectSize [get]

return the size of this object in bytes

Implements GemStone::GemFire::Cache::IGFSerializable.

uint32_t GemStone::GemFire::Cache::Properties::Size [get]

Return the number of entries in the collection.

Returns:

the number of entries

---