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_XML_CONFIGURABLE_HPP 00008 #define COH_XML_CONFIGURABLE_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/run/xml/XmlElement.hpp" 00013 00014 COH_OPEN_NAMESPACE3(coherence,run,xml) 00015 00016 00017 /** 00018 * XmlConfigurable interface represents an {@link coherence::lang::Object 00019 * Object} that can be configured by providing configuration information from 00020 * XML structure. 00021 */ 00022 class COH_EXPORT XmlConfigurable 00023 : public interface_spec<XmlConfigurable> 00024 { 00025 // ----- XmlConfigurable interface -------------------------------------- 00026 00027 public: 00028 /** 00029 * If this {@link coherence::lang::Object Object} was previously 00030 * configured using some XML configuration, the corresponding 00031 * XmlElement is returned. 00032 * 00033 * @return a view of the XmlElement used to configure this Object 00034 */ 00035 virtual XmlElement::View getConfig() const = 0; 00036 00037 /** 00038 * Configure this {@link coherence::lang::Object Object} using the 00039 * provided XmlElement 00040 * 00041 * @param vXml the XML configuration to set 00042 */ 00043 virtual void setConfig(XmlElement::View vXml) = 0; 00044 }; 00045 00046 COH_CLOSE_NAMESPACE3 00047 00048 #endif // COH_XML_CONFIGURABLE_HPP