-/*\r
- * Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file AbstractDOMCachingXMLObject.h\r
- * \r
- * Extension of AbstractXMLObject that implements a DOMCachingXMLObject. \r
- */\r
-\r
-#if !defined(__xmltooling_abstractdomxmlobj_h__)\r
-#define __xmltooling_abstractdomxmlobj_h__\r
-\r
-#include <xmltooling/AbstractXMLObject.h>\r
-#include <xmltooling/DOMCachingXMLObject.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
- * Extension of AbstractXMLObject that implements a DOMCachingXMLObject.\r
- * This is the primary base class for XMLObject implementation classes to use.\r
- */\r
- class XMLTOOL_API AbstractDOMCachingXMLObject : public AbstractXMLObject, public DOMCachingXMLObject\r
- {\r
- public:\r
- virtual ~AbstractDOMCachingXMLObject();\r
- \r
- /**\r
- * @see DOMCachingXMLObject::getDOM()\r
- */\r
- DOMElement* getDOM() const {\r
- return m_dom;\r
- }\r
- \r
- /**\r
- * @see DOMCachingXMLObject::setDOM()\r
- */\r
- void setDOM(DOMElement* dom, bool bindDocument=false);\r
- \r
- /**\r
- * @see DOMCachingXMLObject::setDocument()\r
- */\r
- void setDocument(DOMDocument* doc) {\r
- if (m_document)\r
- m_document->release();\r
- m_document=doc;\r
- }\r
- \r
- /**\r
- * @see DOMCachingXMLObject::releaseDOM()\r
- */\r
- virtual void releaseDOM();\r
- \r
- /**\r
- * @see DOMCachingXMLObject::releaseParentDOM()\r
- */\r
- virtual void releaseParentDOM(bool propagateRelease=true);\r
- \r
- /**\r
- * @see DOMCachingXMLObject::releaseChildrenDOM()\r
- */\r
- virtual void releaseChildrenDOM(bool propagateRelease=true);\r
- \r
- /**\r
- * A convenience method that is equal to calling releaseDOM() then releaseParentDOM(true).\r
- */\r
- void releaseThisandParentDOM() {\r
- if (m_dom) {\r
- releaseDOM();\r
- releaseParentDOM(true);\r
- }\r
- }\r
- \r
- /**\r
- * A convenience method that is equal to calling releaseChildrenDOM(true) then releaseDOM().\r
- */\r
- void releaseThisAndChildrenDOM() {\r
- if (m_dom) {\r
- releaseChildrenDOM(true);\r
- releaseDOM();\r
- }\r
- }\r
- \r
- /**\r
- * @see XMLObject::clone()\r
- */\r
- XMLObject* clone() const;\r
-\r
- protected:\r
- /**\r
- * Constructor\r
- * \r
- * @param namespaceURI the namespace the element is in\r
- * @param elementLocalName the local name of the XML element this Object represents\r
- * @param namespacePrefix the namespace prefix to use\r
- */\r
- AbstractDOMCachingXMLObject(const XMLCh* namespaceURI=NULL, const XMLCh* elementLocalName=NULL, const XMLCh* namespacePrefix=NULL)\r
- : AbstractXMLObject(namespaceURI,elementLocalName, namespacePrefix), m_dom(NULL), m_document(NULL) {}\r
-\r
- /**\r
- * If a DOM representation exists, this clones it into a new document.\r
- * \r
- * @param doc the document to clone into, or NULL, in which case a new document is created\r
- * @return the cloned DOM\r
- */\r
- DOMElement* cloneDOM(DOMDocument* doc=NULL) const;\r
-\r
- /**\r
- * A helper function for derived classes.\r
- * This 'normalizes' newString and then if it is different from oldString\r
- * invalidates the DOM. It returns the normalized value.\r
- * \r
- * @param oldValue - the current value\r
- * @param newValue - the new value\r
- * \r
- * @return the value that should be assigned\r
- */\r
- XMLCh* prepareForAssignment(const XMLCh* oldValue, const XMLCh* newValue) {\r
- XMLCh* newString = XMLString::replicate(newValue);\r
- XMLString::trim(newString);\r
-\r
- if (!XMLString::equals(oldValue,newValue))\r
- releaseThisandParentDOM();\r
- \r
- return newString;\r
- }\r
- \r
- private:\r
- DOMElement* m_dom;\r
- DOMDocument* m_document;\r
- };\r
- \r
-};\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_abstractdomxmlobj_h__ */\r
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+
+/**
+ * @file xmltooling/AbstractDOMCachingXMLObject.h
+ *
+ * AbstractXMLObject mixin that implements DOM caching.
+ */
+
+#ifndef __xmltooling_abstractdomxmlobj_h__
+#define __xmltooling_abstractdomxmlobj_h__
+
+#include <xmltooling/AbstractXMLObject.h>
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+ /**
+ * AbstractXMLObject mixin that implements DOM caching.
+ * Inherit from this class to implement standard DOM caching behavior.
+ */
+ class XMLTOOL_API AbstractDOMCachingXMLObject : public virtual AbstractXMLObject
+ {
+ public:
+ virtual ~AbstractDOMCachingXMLObject();
+
+ // Virtual function overrides.
+ xercesc::DOMElement* getDOM() const;
+ void setDOM(xercesc::DOMElement* dom, bool bindDocument=false) const;
+ void setDocument(xercesc::DOMDocument* doc) const;
+ void releaseDOM() const;
+ void releaseParentDOM(bool propagateRelease=true) const;
+ void releaseChildrenDOM(bool propagateRelease=true) const;
+ XMLObject* clone() const;
+ void detach();
+
+ protected:
+ AbstractDOMCachingXMLObject();
+
+ /** Copy constructor. */
+ AbstractDOMCachingXMLObject(const AbstractDOMCachingXMLObject& src);
+
+ /**
+ * If a DOM representation exists, this clones it into a new document.
+ *
+ * @param doc the document to clone into, or nullptr, in which case a new document is created
+ * @return the cloned DOM
+ */
+ xercesc::DOMElement* cloneDOM(xercesc::DOMDocument* doc=nullptr) const;
+
+ private:
+ mutable xercesc::DOMElement* m_dom;
+ mutable xercesc::DOMDocument* m_document;
+ };
+
+};
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_abstractdomxmlobj_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff