X-Git-Url: http://www.project-moonshot.org/gitweb/?p=shibboleth%2Fcpp-xmltooling.git;a=blobdiff_plain;f=xmltooling%2FAbstractDOMCachingXMLObject.h;h=3f02e32f77a5a3898a9a25dbd176beca7dbf37af;hp=fc740f31eff8053d4d16640d2b2e9033191e5816;hb=HEAD;hpb=c47d9a28b514e071b6fbb1dfce4b5f258d26a67f diff --git a/xmltooling/AbstractDOMCachingXMLObject.h b/xmltooling/AbstractDOMCachingXMLObject.h index fc740f3..3f02e32 100644 --- a/xmltooling/AbstractDOMCachingXMLObject.h +++ b/xmltooling/AbstractDOMCachingXMLObject.h @@ -1,90 +1,83 @@ -/* - * Copyright 2001-2006 Internet2 - * - * Licensed 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 AbstractDOMCachingXMLObject.h - * - * AbstractXMLObject mixin that implements DOM caching - */ - -#if !defined(__xmltooling_abstractdomxmlobj_h__) -#define __xmltooling_abstractdomxmlobj_h__ - -#include - -#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(); - - DOMElement* getDOM() const { - return m_dom; - } - - void setDOM(DOMElement* dom, bool bindDocument=false) const; - - void setDocument(DOMDocument* doc) const { - if (m_document) - m_document->release(); - m_document=doc; - } - - virtual void releaseDOM() const; - - virtual void releaseParentDOM(bool propagateRelease=true) const; - - virtual void releaseChildrenDOM(bool propagateRelease=true) const; - - XMLObject* clone() const; - - protected: - AbstractDOMCachingXMLObject() : m_dom(NULL), m_document(NULL) {} - - /** Copy constructor. */ - AbstractDOMCachingXMLObject(const AbstractDOMCachingXMLObject& src) - : AbstractXMLObject(src), m_dom(NULL), m_document(NULL) {} - - /** - * If a DOM representation exists, this clones it into a new document. - * - * @param doc the document to clone into, or NULL, in which case a new document is created - * @return the cloned DOM - */ - DOMElement* cloneDOM(DOMDocument* doc=NULL) const; - - private: - mutable DOMElement* m_dom; - mutable DOMDocument* m_document; - }; - -}; - -#if defined (_MSC_VER) - #pragma warning( pop ) -#endif - -#endif /* __xmltooling_abstractdomxmlobj_h__ */ +/** + * 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 + +#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__ */