submitted 1.2.0

Util/include/Poco/Util/LayeredConfiguration.h

@@ -0,0 +1,110 @@
+//
+// LayeredConfiguration.h
+//
+// $Id: //poco/1.2/Util/include/Poco/Util/LayeredConfiguration.h#1 $
+//
+// Library: Util
+// Package: Configuration
+// Module:  LayeredConfiguration
+//
+// Definition of the LayeredConfiguration class.
+//
+// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
+// and Contributors.
+//
+// Permission is hereby granted, free of charge, to any person or organization
+// obtaining a copy of the software and accompanying documentation covered by
+// this license (the "Software") to use, reproduce, display, distribute,
+// execute, and transmit the Software, and to prepare derivative works of the
+// Software, and to permit third-parties to whom the Software is furnished to
+// do so, all subject to the following:
+// 
+// The copyright notices in the Software and this entire statement, including
+// the above license grant, this restriction and the following disclaimer,
+// must be included in all copies of the Software, in whole or in part, and
+// all derivative works of the Software, unless such copies or derivative
+// works are solely in the form of machine-executable object code generated by
+// a source language processor.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+
+
+#ifndef Util_LayeredConfiguration_INCLUDED
+#define Util_LayeredConfiguration_INCLUDED
+
+
+#include "Poco/Util/Util.h"
+#include "Poco/Util/AbstractConfiguration.h"
+#include "Poco/AutoPtr.h"
+#include <vector>
+
+
+namespace Poco {
+namespace Util {
+
+
+class Util_API LayeredConfiguration: public AbstractConfiguration
+	/// A LayeredConfiguration consists of a number of AbstractConfigurations.
+	///
+	/// When reading a configuration property in a LayeredConfiguration,
+	/// all added configurations are searched, from the first added to the last added.
+	///
+	/// When setting a property, the property is always written to the last configuration
+	/// added. If no configurations have been added to the LayeredConfiguration, and an
+	/// attempt is made to set a property, a RuntimeException is thrown.
+{
+public:
+	LayeredConfiguration();
+		/// Creates the LayeredConfiguration.
+		
+	void add(AbstractConfiguration* pConfig);
+		/// Adds a configuration to the back of the LayeredConfiguration.
+		/// The LayeredConfiguration does not take ownership of the given
+		/// configuration. In other words, the configuration's reference
+		/// count is incremented.
+
+	void add(AbstractConfiguration* pConfig, bool shared);
+		/// Adds a configuration to the back of the LayeredConfiguration.
+		/// If shared is false, the LayeredConfiguration takes ownership
+		/// of the given configuration (and the configuration's reference
+		/// count remains unchanged).
+
+	void addFront(AbstractConfiguration* pConfig);
+		/// Adds a configuration to the front of the LayeredConfiguration.
+		/// The LayeredConfiguration does not take ownership of the given
+		/// configuration. In other words, the configuration's reference
+		/// count is incremented.
+
+	void addFront(AbstractConfiguration* pConfig, bool shared);
+		/// Adds a configuration to the front of the LayeredConfiguration.
+		/// If shared is true, the LayeredConfiguration takes ownership
+		/// of the given configuration.
+
+protected:
+	bool getRaw(const std::string& key, std::string& value) const;
+	void setRaw(const std::string& key, const std::string& value);
+	void enumerate(const std::string& key, Keys& range) const;
+	~LayeredConfiguration();
+
+private:
+	LayeredConfiguration(const LayeredConfiguration&);
+	LayeredConfiguration& operator = (const LayeredConfiguration&);
+
+	typedef Poco::AutoPtr<AbstractConfiguration> ConfigPtr;
+	typedef std::vector<ConfigPtr> ConfigVec;
+	
+	ConfigVec _configs;
+};
+
+
+} } // namespace Poco::Util
+
+
+#endif // Util_LayeredConfiguration_INCLUDED