Multi-line svn commit, see body.
[shibboleth/cpp-xmltooling.git] / xmltooling / impl / UnknownElement.h
index bfc5b1a..ce23b31 100644 (file)
  */\r
 \r
 /**\r
- * UnknownElement.h\r
+ * @file xmltooling/impl/UnknownElement.h\r
  * \r
- * Basic implementations suitable for use as defaults for unrecognized content\r
+ * Basic implementation suitable for use as default for unrecognized content\r
  */\r
 \r
-#if !defined(__xmltooling_unkelement_h__)\r
+#ifndef __xmltooling_unkelement_h__\r
 #define __xmltooling_unkelement_h__\r
 \r
-#include "internal.h"\r
-#include "XMLObjectBuilder.h"\r
-#include "io/AbstractXMLObjectMarshaller.h"\r
-#include "io/AbstractXMLObjectUnmarshaller.h"\r
+#include <xmltooling/AbstractSimpleElement.h>\r
+#include <xmltooling/exceptions.h>\r
+#include <xmltooling/XMLObjectBuilder.h>\r
+#include <xmltooling/io/AbstractXMLObjectMarshaller.h>\r
+#include <xmltooling/io/AbstractXMLObjectUnmarshaller.h>\r
 \r
 #include <string>\r
 \r
 \r
 namespace xmltooling {\r
 \r
-    class XMLTOOL_DLLLOCAL UnknownElementImpl : public AbstractDOMCachingXMLObject\r
+    /// @cond off\r
+    class XMLTOOL_DLLLOCAL UnknownElementImpl : public AbstractSimpleElement, public AbstractDOMCachingXMLObject\r
     {\r
     public:\r
         UnknownElementImpl(const XMLCh* namespaceURI=NULL, const XMLCh* elementLocalName=NULL, const XMLCh* namespacePrefix=NULL)\r
-            : AbstractDOMCachingXMLObject(namespaceURI, elementLocalName, namespacePrefix) {}\r
+            : AbstractXMLObject(namespaceURI, elementLocalName, namespacePrefix) {}\r
     \r
-        void releaseDOM();\r
+        void releaseDOM() const;\r
 \r
         XMLObject* clone() const;\r
 \r
-        DOMElement* marshall(DOMDocument* document=NULL, MarshallingContext* ctx=NULL) const;\r
-        DOMElement* marshall(DOMElement* parentElement, MarshallingContext* ctx=NULL) const;\r
+        const XMLCh* getTextContent(unsigned int position=0) const {\r
+            throw XMLObjectException("Direct access to content is not permitted.");\r
+        }\r
+\r
+        void setTextContent(const XMLCh*, unsigned int position=0) {\r
+            throw XMLObjectException("Direct access to content is not permitted.");\r
+        }\r
+\r
+        DOMElement* marshall(\r
+            DOMDocument* document=NULL\r
+#ifndef XMLTOOLING_NO_XMLSEC\r
+            ,const std::vector<xmlsignature::Signature*>* sigs=NULL\r
+#endif\r
+            ) const;\r
+\r
+        DOMElement* marshall(\r
+            DOMElement* parentElement\r
+#ifndef XMLTOOLING_NO_XMLSEC\r
+            ,const std::vector<xmlsignature::Signature*>* sigs=NULL\r
+#endif\r
+            ) const;\r
         XMLObject* unmarshall(DOMElement* element, bool bindDocument=false);\r
         \r
     protected:\r
         void setDocumentElement(DOMDocument* document, DOMElement* element) const {\r
             DOMElement* documentRoot = document->getDocumentElement();\r
             if (documentRoot)\r
-                document->replaceChild(documentRoot, element);\r
+                document->replaceChild(element, documentRoot);\r
             else\r
                 document->appendChild(element);\r
         }\r
@@ -64,13 +85,18 @@ namespace xmltooling {
 \r
         void serialize(std::string& s) const;\r
     };\r
-\r
-    class XMLTOOL_DLLLOCAL UnknownElementBuilder : public XMLObjectBuilder\r
+    /// @endcond\r
+    \r
+    /**\r
+     * Builder for UnknownElementImpl objects.\r
+     * Use as the default builder when you want unknown DOM content treated as raw/ignored XML.\r
+     */\r
+    class XMLTOOL_API UnknownElementBuilder : public XMLObjectBuilder\r
     {\r
     public:\r
-        UnknownElementImpl* buildObject() const {\r
-            return new UnknownElementImpl();\r
-        }\r
+        XMLObject* buildObject(\r
+            const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL\r
+            ) const;\r
     };\r
 \r
 };\r