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)
String^	Find (String^ key)
void	ForEach (PropertyVisitor^ visitor)
virtual IGFSerializable^	FromData (DataInput^ input)
void	Insert (String^ key, Int32 value)
void	Insert (String^ key, String^ value)
void	Load (String^ fileName)
void	Remove (String^ key)
virtual void	ToData (DataOutput^ output)
String^	ToString ()
Static Public Member Functions
static Properties^	Create ()
Properties
virtual Byte	ClassId [get]
virtual UInt32	ObjectSize [get]
UInt32	Size [get]

---

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

(

)

[static]

Factory method, returns an empty collection.

Returns:

empty collection of properties

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

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	(	String^	key,
		Int32	value
	)

Add or update the int value for key.

Parameters:

	key	the key to insert
	value	the integer value to insert

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

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

(

String^

key

)

Remove the key from the collection.

Parameters:

key

the key to remove

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.

String ^ GemStone::GemFire::Cache::IGFSerializable::ToString

(

)

[inherited]

Return a string representation of the object.

Implemented in GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableString, GemStone::GemFire::Cache::Serializable, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireTypeIds::CacheableCharacter >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireTypeIds::CacheableFloat >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableBoolean, Boolean, GemFireTypeIds::CacheableBoolean >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireTypeIds::CacheableByte >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt16, Int16, GemFireTypeIds::CacheableInt16 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt32, Int32, GemFireTypeIds::CacheableInt32 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireTypeIds::CacheableDouble >, and GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt64, Int64, GemFireTypeIds::CacheableInt64 >.

---

Property Documentation

virtual Byte 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.

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

return the size of this object in bytes

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

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

Return the number of entries in the collection.

Returns:

the number of entries

---