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_CONVERTER_HPP 00008 #define COH_CONVERTER_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 COH_OPEN_NAMESPACE2(coherence,util) 00013 00014 00015 /** 00016 * Interface for conversion from one {@link coherence::lang::Object 00017 * Object} type to another one. 00018 * 00019 * @author mf 2007.07.05 00020 */ 00021 class COH_EXPORT Converter 00022 : public interface_spec<Converter> 00023 { 00024 // ----- Converter interface -------------------------------------------- 00025 00026 public: 00027 /** 00028 * Convert an {@link coherence::lang::Object Object} referenced 00029 * by the supplied holder. 00030 * 00031 * @param oh the holder to the Object to convert 00032 * 00033 * @return the holder to the converted Object 00034 */ 00035 virtual Object::Holder convert(Object::Holder oh) const = 0; 00036 00037 00038 // ----- static methods ------------------------------------------------- 00039 00040 public: 00041 /** 00042 * Convert the {@link coherence::lang::Object Object} referenced 00043 * by the supplied Object::Holder using the supplied Converter. 00044 * 00045 * @param vConvert a handle to the Converter to use 00046 * @param oh a holder to the Object to convert 00047 * 00048 * @return a holder of the converted Object, or the unconverted Object 00049 * if the Converter is NULL 00050 */ 00051 static Object::Holder convert(Converter::View vConvert, Object::Holder oh); 00052 00053 /** 00054 * Convert the {@link coherence::lang::Object Object} referenced 00055 * by the supplied handle using the supplied Converter. 00056 * 00057 * @param vConvert a handle to the Converter to use 00058 * @param h a handle to the Object to convert 00059 * 00060 * @return a handle of the converted Object, or the unconverted Object 00061 * if the Converter is NULL 00062 */ 00063 static Object::Handle convertHandle(Converter::View vConvert, Object::Handle h); 00064 }; 00065 00066 COH_CLOSE_NAMESPACE2 00067 00068 #endif // COH_CONVERTER_HPP