Oracle Coherence for C++ API: TypedUpdater Class Template Reference

Detailed Description

template<class A, class C, void(C::*)(A) M, class AH = A, class OH = typename C::Handle>
class coherence::util::extractor::TypedUpdater< A, C, M, AH, OH >

Template based ValueUpdater implementation.

This updater functions on non-const methods which take Objects, for an updater which works with non-Object types see BoxUpdater.

For ease of use the COH_TYPED_UPDATER macro can be used to easily construct an instance of this class. For example the following constructs an updater for calling the "void Address::setState(String::View)" method.

 ValueUpdater::View vUpd = COH_TYPED_UPDATER(Address, setState, String::View);

Author:

mf 2009.07.29

Public Types

typedef spec::Handle

Handle

TypedUpdater<A, C, M, AH, OH> Handle definition.

typedef spec::View

View

TypedUpdater<A, C, M, AH, OH> View definition.

typedef spec::Holder

Holder

TypedUpdater<A, C, M, AH, OH> 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 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

Protected Member Functions

TypedUpdater ()

Construct a TypedUpdater.

TypedUpdater (String::View vsMethod)

Construct a TypedUpdater based on a method name and optional parameters.

Constructor & Destructor Documentation

TypedUpdater ( String::View vsMethod ) [inline, protected]

Construct a TypedUpdater based on a method name and optional parameters.

The method name is only used for the purposes of serializing the updater for execution on remote Java members.

Parameters:

vsMethod

the name of the method to invoke via reflection

TypedUpdater Class Template Reference

Detailed Description

template<class A, class C, void(C::*)(A) M, class AH = A, class OH = typename C::Handle> class coherence::util::extractor::TypedUpdater< A, C, M, AH, OH >

Public Types

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

template<class A, class C, void(C::*)(A) M, class AH = A, class OH = typename C::Handle>
class coherence::util::extractor::TypedUpdater< A, C, M, AH, OH >