#include <coherence/util/extractor/TypedExtractor.hpp>
Inherits ReflectionExtractor.
Inherited by BoxExtractor.
This extractor functions on const methods which return Objects, for an extractor which works with non-Object return types see BoxExtractor.
For ease of use the COH_TYPED_EXTRACTOR macro can be used to easily construct an instance of this class. For example the following constructs an extractor for calling the "String::View Address::getState() const" method.
ValueExtractor::View vExt = COH_TYPED_EXTRACTOR(String::View, Address, getState);
Public Types | |||||||||||||
typedef spec::Handle | Handle | ||||||||||||
TypedExtractor<R, C, M, RH, OH> Handle definition. | |||||||||||||
typedef spec::View | View | ||||||||||||
TypedExtractor<R, C, M, RH, OH> View definition. | |||||||||||||
typedef spec::Holder | Holder | ||||||||||||
TypedExtractor<R, C, M, RH, OH> Holder definition. | |||||||||||||
Public Member Functions | |||||||||||||
virtual Object::Holder | extract (Object::Holder ohTarget) const | ||||||||||||
Extract the value from the passed object. The returned value may be NULL.
| |||||||||||||
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
The default implementation is identity based.
| |||||||||||||
virtual TypedHandle < const String > | toString () const | ||||||||||||
Output a human-readable description of this Object to the given stream. Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override. coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toString 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 and is generally how toString() will be implemented.
Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::View vs = COH_TO_STRING(vKey << " = " << vValue); The COH_TO_STRING macro is also the most common way to implement the toString method. For example:
virtual TypedHandle<const String> Person::toString() const { return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN); }
| |||||||||||||
Protected Member Functions | |||||||||||||
TypedExtractor () | |||||||||||||
Construct a TypedExtractor. | |||||||||||||
TypedExtractor (String::View vsMethod) | |||||||||||||
Construct a TypedExtractor based on a method name and optional parameters. |
TypedExtractor | ( | String::View | vsMethod | ) | [inline, protected] |
Construct a TypedExtractor based on a method name and optional parameters.
The method name is only used for the purposes of serializing the extractor for execution on remote Java members.
vsMethod | the name of the method to invoke via reflection |