Contains a set of (key, value) pair properties with key being the name of the property; value, the value of the property. More...

Inherits apache::geode::client::Serializable.

Public Member Functions
void	addAll (const PropertiesPtr &other)
	Add the contents of other to this instance, replacing any existing values with those from other. More...

virtual int32_t	classId () const
	Return class id for serialization. More...

virtual int8_t	DSFID () const
	return the Data Serialization Fixed ID type. More...

CacheableStringPtr	find (const char *key)
	Return the value for the given key, or NULLPTR if not found. More...

CacheablePtr	find (const CacheableKeyPtr &key)
	Return the value for the given `CacheableKey`, or NULLPTR if not found. More...

void	foreach (Visitor &visitor) const
	Execute the Visitor's `visit( const char* key, const char* value )` method for each entry in the collection. More...

virtual Serializable *	fromData (DataInput &input)
	deserialize this object More...

uint32_t	getSize () const
	Return the number of entries in the collection. More...

void	insert (const char key, const char value)
	Add or update the string value for key. More...

void	insert (const char *key, const int value)
	Add or update the int value for key. More...

void	insert (const CacheableKeyPtr &key, const CacheablePtr &value)
	Add or update Cacheable value for CacheableKey. More...

void	load (const char *fileName)
	Read property values from a file, overriding what is currently in the properties object. More...

virtual uint32_t	objectSize () const
	return the size in bytes of the instance being serialized. More...

void	preserveSB () const
	Atomically increment reference count. More...

int32_t	refCount ()

void	releaseSB () const
	Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...

void	remove (const char *key)
	Remove the key from the collection. More...

void	remove (const CacheableKeyPtr &key)
	Remove the `CacheableKey` from the collection. More...

virtual void	toData (DataOutput &output) const
	serialize this object More...

virtual CacheableStringPtr	toString () const
	Display this object as 'string', which depends on the implementation in the subclasses. More...

virtual int8_t	typeId () const
	Return type id for serialization. More...

virtual	~Properties ()
	destructor. More...

Static Public Member Functions
static PropertiesPtr	create ()
	Factory method, returns an empty collection. More...

template<class PRIM >
static SerializablePtr	create (const PRIM value)
	Factory method that creates the Serializable object that matches the type of value. More...

static Serializable *	createDeserializable ()
	Return an empty instance for deserialization. More...

static void	registerPdxSerializer (PdxSerializerPtr pdxSerializer)
	Register the PDX serializer which can handle serialization for instances of user domain classes. More...

static void	registerPdxType (TypeFactoryMethodPdx creationFunction)
	register an Pdx instance factory method for a given type. More...

static void	registerType (TypeFactoryMethod creationFunction)
	register an instance factory method for a given type. More...

Detailed Description

Contains a set of (key, value) pair properties with key being the name of the property; value, the value of the property.

Constructor & Destructor Documentation

virtual apache::geode::client::Properties::~Properties ( )

virtual

destructor.

Member Function Documentation

void apache::geode::client::Properties::addAll ( const PropertiesPtr & other )

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

virtual int32_t apache::geode::client::Properties::classId ( ) const

virtual

Return class id for serialization.

Implements apache::geode::client::Serializable.

static PropertiesPtr apache::geode::client::Properties::create ( )

static

Factory method, returns an empty collection.

template<class PRIM >

static SerializablePtr apache::geode::client::Serializable::create ( const PRIM value )

inlinestaticinherited

Factory method that creates the Serializable object that matches the type of value.

For customer defined derivations of Serializable, the method apache::geode::client::createValue may be overloaded. For pointer types (e.g. char*) the method apache::geode::client::createValueArr may be overloaded.

static Serializable* apache::geode::client::Properties::createDeserializable ( )

static

Return an empty instance for deserialization.

virtual int8_t apache::geode::client::Serializable::DSFID ( ) const

virtualinherited

return the Data Serialization Fixed ID type.

This is used to determine what instance type to create and deserialize into.

Note that this should not be overridden by custom implementations and is reserved only for builtin types.

Reimplemented in apache::geode::client::Struct, and apache::geode::client::CacheableUndefined.

CacheableStringPtr apache::geode::client::Properties::find ( const char * key )

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

Exceptions

NullPointerException if the key is null

CacheablePtr apache::geode::client::Properties::find ( const CacheableKeyPtr & key )

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

Exceptions

NullPointerException if the key is NULLPTR

void apache::geode::client::Properties::foreach ( Visitor & visitor ) const

Execute the Visitor's visit( const char* key, const char* value ) method for each entry in the collection.

virtual Serializable* apache::geode::client::Properties::fromData ( DataInput & input )

virtual

deserialize this object

Implements apache::geode::client::Serializable.

uint32_t apache::geode::client::Properties::getSize ( ) const

Return the number of entries in the collection.

void apache::geode::client::Properties::insert	(	const char *	key,
		const char *	value
	)

Add or update the string value for key.

Exceptions

NullPointerException if the key is null

void apache::geode::client::Properties::insert	(	const char *	key,
		const int	value
	)

Add or update the int value for key.

Exceptions

NullPointerException if the key is null

void apache::geode::client::Properties::insert	(	const CacheableKeyPtr &	key,
		const CacheablePtr &	value
	)

Add or update Cacheable value for CacheableKey.

Exceptions

NullPointerException if the key is NULLPTR

void apache::geode::client::Properties::load ( const char * fileName )

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

virtual uint32_t apache::geode::client::Properties::objectSize ( ) const

inlinevirtual

return the size in bytes of the instance being serialized.

This is used to determine whether the cache is using up more physical memory than it has been configured to use. The method can return zero if the user does not require the ability to control cache memory utilization. Note that you must implement this only if you use the HeapLRU feature.

Reimplemented from apache::geode::client::Serializable.

void apache::geode::client::SharedBase::preserveSB ( ) const

inherited

Atomically increment reference count.

int32_t apache::geode::client::SharedBase::refCount ( )

inlineinherited

Returns: the reference count

static void apache::geode::client::Serializable::registerPdxSerializer ( PdxSerializerPtr pdxSerializer )

staticinherited

Register the PDX serializer which can handle serialization for instances of user domain classes.

See also: PdxSerializer

static void apache::geode::client::Serializable::registerPdxType ( TypeFactoryMethodPdx creationFunction )

staticinherited

register an Pdx instance factory method for a given type.

Exceptions

IllegalStateException if the typeName has already been registered, or there is an error in registering the type; check errno for more information in the latter case.

static void apache::geode::client::Serializable::registerType ( TypeFactoryMethod creationFunction )

staticinherited

register an instance factory method for a given type.

During registration the factory will be invoked to extract the typeId to associate with this function.

Exceptions

IllegalStateException if the typeId has already been registered, or there is an error in registering the type; check errno for more information in the latter case.

void apache::geode::client::SharedBase::releaseSB ( ) const

inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

void apache::geode::client::Properties::remove ( const char * key )

Remove the key from the collection.

Exceptions

NullPointerException if the key is null

void apache::geode::client::Properties::remove ( const CacheableKeyPtr & key )

Remove the CacheableKey from the collection.

Exceptions

NullPointerException if the key is NULLPTR

virtual void apache::geode::client::Properties::toData ( DataOutput & output ) const

virtual

serialize this object

Implements apache::geode::client::Serializable.

virtual CacheableStringPtr apache::geode::client::Serializable::toString ( ) const

virtualinherited

Display this object as 'string', which depends on the implementation in the subclasses.

The default implementation renders the classname.

The return value may be a temporary, so the caller has to ensure that the SharedPtr count does not go down to zero by storing the result in a variable or otherwise.

Reimplemented in apache::geode::client::PdxInstance, apache::geode::client::CacheableString, apache::geode::client::CacheableDate, apache::geode::client::CacheableEnum, and apache::geode::client::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >.

virtual int8_t apache::geode::client::Properties::typeId ( ) const

virtual

Return type id for serialization.

Reimplemented from apache::geode::client::Serializable.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation