Multi-line svn commit, see body.

[shibboleth/cpp-xmltooling.git] / xmltooling / io / AbstractXMLObjectMarshaller.h

diff --git a/xmltooling/io/AbstractXMLObjectMarshaller.h b/xmltooling/io/AbstractXMLObjectMarshaller.h
index beed4b3..cbab2fe 100644 (file)
--- a/xmltooling/io/AbstractXMLObjectMarshaller.h
+++ b/xmltooling/io/AbstractXMLObjectMarshaller.h
@@ -23,31 +23,39 @@
 #if !defined(__xmltooling_xmlmarshaller_h__)\r
 #define __xmltooling_xmlmarshaller_h__\r
 \r
-#include <xmltooling/io/Marshaller.h>\r
+#include <xmltooling/AbstractDOMCachingXMLObject.h>\r
+\r
+#if defined (_MSC_VER)\r
+    #pragma warning( push )\r
+    #pragma warning( disable : 4250 4251 )\r
+#endif\r
 \r
 namespace xmltooling {\r
 \r
     /**\r
      * A thread-safe abstract marshaller.\r
      */\r
-    class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual Marshaller\r
+    class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual AbstractXMLObject\r
     {\r
     public:\r
         virtual ~AbstractXMLObjectMarshaller() {}\r
 \r
-        /**\r
-         * @see Marshaller::marshall(XMLObject*,DOMDocument*)\r
-         */\r
-        DOMElement* marshall(XMLObject* xmlObject, DOMDocument* document=NULL) const;\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
-        /**\r
-         * @see Marshaller::marshall(XMLObject*,DOMElement*)\r
-         */\r
-        DOMElement* marshall(XMLObject* xmlObject, DOMElement* parentElement) 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
         \r
     protected:\r
-        AbstractXMLObjectMarshaller();\r
+        AbstractXMLObjectMarshaller() {}\r
 \r
         /**\r
          * Sets the given element as the Document Element of the given Document.\r
@@ -59,73 +67,68 @@ namespace xmltooling {
         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
     \r
         /**\r
-         * Marshalls the given XMLObject into the given DOM Element.\r
+         * Marshalls the XMLObject into the given DOM Element.\r
          * The DOM Element must be within a DOM tree rooted in the owning Document.\r
          * \r
-         * @param xmlObject the XMLObject to marshall\r
          * @param targetElement the Element into which the XMLObject is marshalled into\r
+         * @param ctx           optional marshalling context\r
+         * \r
          * @throws MarshallingException thrown if there is a problem marshalling the object\r
+         * @throws SignatureException thrown if a problem occurs during signature creation \r
          */\r
-        void marshallInto(XMLObject& xmlObject, DOMElement* targetElement) const;\r
+        void marshallInto(\r
+            DOMElement* targetElement\r
+#ifndef XMLTOOLING_NO_XMLSEC\r
+            ,const std::vector<xmlsignature::Signature*>* sigs\r
+#endif\r
+            ) const;\r
     \r
         /**\r
          * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.\r
          * \r
-         * @param xmlObject the XMLObject\r
          * @param domElement the DOM element\r
          * \r
          * @throws MarshallingException thrown if the type on the XMLObject is doesn't contain\r
          * a local name, prefix, and namespace URI\r
          */\r
-        void marshallElementType(XMLObject& xmlObject, DOMElement* domElement) const;\r
+        void marshallElementType(DOMElement* domElement) const;\r
 \r
         /**\r
-         * Creates the xmlns attributes for any namespaces set on the given XMLObject.\r
+         * Creates the xmlns attributes for any namespaces set on the XMLObject.\r
          * \r
-         * @param xmlObject the XMLObject\r
          * @param domElement the DOM element the namespaces will be added to\r
          */\r
-        void marshallNamespaces(const XMLObject& xmlObject, DOMElement* domElement) const;\r
+        void marshallNamespaces(DOMElement* domElement) const;\r
     \r
         /**\r
-         * Marshalls the child elements of the given XMLObject.\r
+         * Marshalls the text content and/or child elements of the XMLObject.\r
          * \r
-         * @param xmlObject the XMLObject whose children will be marshalled\r
          * @param domElement the DOM element that will recieved the marshalled children\r
          * \r
          * @throws MarshallingException thrown if there is a problem marshalling a child element\r
          */\r
-        void marshallChildElements(const XMLObject& xmlObject, DOMElement* domElement) const;\r
+        void marshallContent(DOMElement* domElement) const;\r
 \r
         /**\r
-         * Marshalls the attributes from the given XMLObject into the given DOM element.\r
-         * The XMLObject passed to this method is guaranteed to be of the target name\r
-         * specified during this marshaller's construction.\r
+         * Marshalls the attributes from the XMLObject into the given DOM element.\r
          * \r
-         * @param xmlObject the XMLObject being marshalled\r
          * @param domElement the DOM Element into which attributes will be marshalled\r
          * \r
-         * @throws UnmarshallingException thrown if there is a problem unmarshalling an attribute\r
+         * @throws MarshallingException thrown if there is a problem marshalling an attribute\r
          */\r
-        virtual void marshallAttributes(const XMLObject& xmlObject, DOMElement* domElement) const=0;\r
-\r
-        /**\r
-         * Marshalls data from the XMLObject into content of the DOM Element.\r
-         * \r
-         * @param xmlObject the XMLObject\r
-         * @param domElement the DOM element recieving the content\r
-         */\r
-        virtual void marshallElementContent(const XMLObject& xmlObject, DOMElement* domElement) const=0;\r
-\r
-        void* m_log;\r
+        virtual void marshallAttributes(DOMElement* domElement) const {}\r
     };\r
     \r
 };\r
 \r
+#if defined (_MSC_VER)\r
+    #pragma warning( pop )\r
+#endif\r
+\r
 #endif /* __xmltooling_xmlmarshaller_h__ */\r