summaryrefslogtreecommitdiffstats
path: root/upstream/parameter/DefaultElementLibrary.h
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/parameter/DefaultElementLibrary.h')
-rw-r--r--upstream/parameter/DefaultElementLibrary.h96
1 files changed, 96 insertions, 0 deletions
diff --git a/upstream/parameter/DefaultElementLibrary.h b/upstream/parameter/DefaultElementLibrary.h
new file mode 100644
index 0000000..9223021
--- /dev/null
+++ b/upstream/parameter/DefaultElementLibrary.h
@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2011-2015, Intel Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#pragma once
+
+#include "ElementLibrary.h"
+#include "ElementBuilder.h"
+
+#include <map>
+#include <string>
+#include <memory>
+#include <utility>
+
+/** Factory that creates an element given an xml element. If no matching builder is found, it uses
+ * the default builder.
+ *
+ * @tparam CDefaultElementBuilder is the class of the element builder to use if no corresponding
+ * builder is found for a given xml element.
+ */
+template <class CDefaultElementBuilder>
+class CDefaultElementLibrary : public CElementLibrary
+{
+public:
+ virtual ~CDefaultElementLibrary() = default;
+
+ /** Set the default builder used in fallback mechanism.
+ * @see createElement() for more detail on this mechanism.
+ *
+ * @param[in] defaultBuilder if NULL default builder mechanism, else provided builder is used.
+ */
+ void setDefaultBuilder(std::unique_ptr<CDefaultElementBuilder> defaultBuilder)
+ {
+ _defaultBuilder = std::move(defaultBuilder);
+ }
+
+ /** Create and return an element instanciated depending on an xmlElement.
+ *
+ * @param[in] xmlElement: The xml element used to find a matching builder
+ *
+ * @return If a matching builder is found, return an element created from the builder,
+ * otherwise:
+ * If the default mechanism is enable (@see enableDefaultMechanism),
+ * create the elemen with the default element builder.
+ * otherwise, return NULL.
+ */
+ CElement *createElement(const CXmlElement &xmlElement) const;
+
+private:
+ std::unique_ptr<CDefaultElementBuilder> _defaultBuilder;
+};
+
+template <class CDefaultElementBuilder>
+CElement *CDefaultElementLibrary<CDefaultElementBuilder>::createElement(
+ const CXmlElement &xmlElement) const
+{
+ CElement *builtElement = CElementLibrary::createElement(xmlElement);
+
+ if (builtElement != NULL) {
+ // The element was created, return it
+ return builtElement;
+ }
+
+ if (_defaultBuilder == nullptr) {
+ // The default builder mechanism is not enabled
+ return NULL;
+ }
+
+ // Use the default builder
+ return _defaultBuilder->createElement(xmlElement);
+}