00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_BOX_EXTRACTOR_HPP 00008 #define COH_BOX_EXTRACTOR_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/util/extractor/TypedExtractor.hpp" 00013 00014 COH_OPEN_NAMESPACE3(coherence,util,extractor) 00015 00016 00017 /** 00018 * Template based auto-boxing ValueExtractor implementation. 00019 * 00020 * This extractor functions on const methods which return unmanaged types for 00021 * which there is a corresponding the is a managed type which can "box" 00022 * them via a BoxHandle. 00023 * 00024 * For ease of use the COH_BOX_EXTRACTOR macro can be used to easily construct 00025 * an instance of this class. For example the following constructs an extractor 00026 * for calling the "int32_t Address::getZip() const" method. 00027 * 00028 * @code 00029 * ValueExtractor::View vExt = COH_BOX_EXTRACTOR(Integer32::View, Address, getZip); 00030 * @endcode 00031 * 00032 * In the case that the supplied class does not extend from Object and instead 00033 * relies on the Managed<> wrapper, the COH_MANAGED_BOX_EXTRACTOR is to be 00034 * used. 00035 * 00036 * @author mf 2009.03.20 00037 * 00038 * @see TypedExtractor 00039 */ 00040 template<class RH, class C, typename RH::ValueType::BoxedType (C::*M)() const, 00041 class OH = typename C::Holder> 00042 class BoxExtractor 00043 : public class_spec<BoxExtractor<RH, C, M, OH>, 00044 extends<TypedExtractor<typename RH::ValueType::BoxedType, C, M, 00045 BoxHandle<typename RH::ValueType>, OH> > > 00046 { 00047 friend class factory<BoxExtractor<RH, C, M, OH> >; 00048 00049 // ----- constructors --------------------------------------------------- 00050 00051 protected: 00052 /** 00053 * Construct a BoxExtractor 00054 */ 00055 BoxExtractor() 00056 { 00057 } 00058 00059 /** 00060 * Construct a BoxExtractor based on a method name and optional 00061 * parameters. 00062 * 00063 * The method name is only used for the purposes of serializing the 00064 * extractor for execution on remote Java members. 00065 * 00066 * @param vsMethod the name of the method to invoke via reflection 00067 */ 00068 BoxExtractor(String::View vsMethod) 00069 : class_spec<BoxExtractor<RH, C, M, OH>, 00070 extends<TypedExtractor<typename RH::ValueType::BoxedType, C, M, 00071 BoxHandle<typename RH::ValueType>, OH> > >(vsMethod) 00072 { 00073 } 00074 }; 00075 00076 COH_CLOSE_NAMESPACE3 00077 00078 /** 00079 * Helper macro for creating a BoxExtractor. 00080 * 00081 * @param H the handle type to box to, i.e. Integer32::View 00082 * @param C the class to call the method on, i.e. Address 00083 * @param M the method to call, i.e. getZip 00084 */ 00085 #define COH_BOX_EXTRACTOR(H, C, M) \ 00086 coherence::util::extractor::BoxExtractor<H, C, &C::M>::create(#M) 00087 00088 /** 00089 * Helper macro for creating a BoxExtractor around a Managed<> wrapped class. 00090 * 00091 * @param H the handle type to box to, i.e. Integer32::View 00092 * @param C the Managed<> wrapped class to call the method on, i.e. Address 00093 * @param M the method to call, i.e. getZip 00094 */ 00095 #define COH_MANAGED_BOX_EXTRACTOR(H, C, M) \ 00096 coherence::util::extractor::BoxExtractor<H, C, &C::M, \ 00097 coherence::lang::Managed<C>::Holder>::create(#M) 00098 00099 #endif // COH_BOX_EXTRACTOR_HPP