/* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2002 The Apache Software Foundation. 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. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR * ITS 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. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 1999, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * . */ /* * $Id: DOM_Comment.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $ */ #ifndef DOM_Comment_HEADER_GUARD_ #define DOM_Comment_HEADER_GUARD_ #include #include "DOM_CharacterData.hpp" XERCES_CPP_NAMESPACE_BEGIN class CommentImpl; /** * Class to refer to XML comment nodes in the DOM. * *

The string value contains all of the characters between * the starting '<!--' and ending '-->'. */ class CDOM_EXPORT DOM_Comment: public DOM_CharacterData { public: /** @name Constructors and assignment operators */ //@{ /** * Default constructor for DOM_Comment. The resulting object does not * refer to an actual Comment node; it will compare == to 0, and is similar * to a null object reference variable in Java. It may subsequently be * assigned to refer to an actual comment node. *

* New comment nodes are created by DOM_Document::createComment(). * */ DOM_Comment(); /** * Copy constructor. Creates a new DOM_Comment that refers to the * same underlying node as the original. See also DOM_Node::clone(), * which will copy the actual Comment node, rather than just creating a new * reference to the original node. * * @param other The object to be copied. */ DOM_Comment(const DOM_Comment &other); /** * Assignment operator. * * @param other The object to be copied. */ DOM_Comment & operator = (const DOM_Comment &other); /** * Assignment operator. This overloaded variant is provided for * the sole purpose of setting a DOM_Node reference variable to * zero. Nulling out a reference variable in this way will decrement * the reference count on the underlying Node object that the variable * formerly referenced. This effect is normally obtained when reference * variable goes out of scope, but zeroing them can be useful for * global instances, or for local instances that will remain in scope * for an extended time, when the storage belonging to the underlying * node needs to be reclaimed. * * @param val Only a value of 0, or null, is allowed. */ DOM_Comment & operator = (const DOM_NullPtr *val); //@} /** @name Destructor. */ //@{ /** * Destructor for DOM_Comment. The object being destroyed is the reference * object, not the underlying Comment node itself. * */ ~DOM_Comment(); //@} protected: DOM_Comment(CommentImpl *comment); friend class DOM_Document; }; XERCES_CPP_NAMESPACE_END #endif