Oracle Coherence for C++ API: ReflectionUpdater Class Reference

Detailed Description

ValueUpdater

ReflectionUpdater cannot be executed against local C++ caches, only against remote caches. Locally executable C++ updaters may either be custom built, or auto-generated via TypedUpdater<>.

Author:

djl 2008.04.08

Public Types

typedef spec::Handle

Handle

ReflectionUpdater Handle definition.

typedef spec::View

View

ReflectionUpdater View definition.

typedef spec::Holder

Holder

ReflectionUpdater Holder definition.

Public Member Functions

virtual void

update (Object::Handle hTarget, Object::Holder ohValue) const

Update the state of the passed target object using the passed value.

Parameters:

	hTarget	the Object to update the state of
	ohValue	the new value to update the state with

Exceptions:

	ClassCastException	if this ValueUpdater is incompatible with the passed target object or the value and the implementation requires the passed object or the value to be of a certain type
	Exception	if this ValueUpdater encounters a checked exception in the course of updating the target object
	IllegalArgumentException	if this ValueUpdater cannot handle the passed target object or value for any other reason; an implementor should include a descriptive message

virtual void

readExternal (PofReader::Handle hIn)

virtual void

writeExternal (PofWriter::Handle hOut) const

virtual bool

equals (Object::View v) const

virtual size32_t

hashCode () const

Return a hash code value for the Object.

This method is supported for the benefit of hash-based containers.

The general contract of hashCode is:

Whenever it is invoked on the same Object more than once during an execution of an application, the hashCode method must consistently return the same value, provided no information used in equals comparisons on the object is modified. This value need not remain consistent from one execution of an application to another execution of the same application.
If two Objects are equal according to the equals method, then calling the hashCode method on each of the two Objects must produce the same value.
It is not required that if two Objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct results. However, the programmer should be aware that producing distinct results for unequal objects may improve the performance of hash-based containers.

The default implementation is identity based.

Returns:: a hash code value for this Object

virtual void

toStream (std::ostream &out) const

Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);

Parameters:

out

the stream used to output the description

virtual String::View

getMethodName () const

Determine the name of the method that this extractor is configured to invoke.

Protected Member Functions

ReflectionUpdater ()

Construct an empty ReflectionUpdater (necessary for the PortableObject interface).

ReflectionUpdater (String::View vsMethod)

Construct a ReflectionUpdater for a given method name.

ReflectionUpdater (const ReflectionUpdater &that)

Copy constructor.

Protected Attributes

MemberView< String >

m_vsMethod

The name of the method to invoke.

Constructor & Destructor Documentation

ReflectionUpdater ( String::View vsMethod ) [protected]

Construct a ReflectionUpdater for a given method name.

This implementation assumes that the corresponding classes will have one and only one method with a specified name and this method will have exactly one parameter.

Member Function Documentation

virtual void update	(	Object::Handle	hTarget,
		Object::Holder	ohValue
	)			const `[virtual]`

Update the state of the passed target object using the passed value.

Parameters:

	hTarget	the Object to update the state of
	ohValue	the new value to update the state with

Exceptions:

	ClassCastException	if this ValueUpdater is incompatible with the passed target object or the value and the implementation requires the passed object or the value to be of a certain type
	Exception	if this ValueUpdater encounters a checked exception in the course of updating the target object
	IllegalArgumentException	if this ValueUpdater cannot handle the passed target object or value for any other reason; an implementor should include a descriptive message

Exceptions:

UnsupportedOperationException

always

Implements ValueUpdater.

Reimplemented in TypedUpdater, and TypedUpdater< AH::ValueType::BoxedType, C, M, coherence::lang::BoxHandle< AH::ValueType >, OH >.

virtual String::View getMethodName ( ) const [virtual]

Determine the name of the method that this extractor is configured to invoke.

Returns:: the name of the method to invoke using reflection