DOM_XMLDecl.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:5k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Id: DOM_XMLDecl.hpp,v 1.2 2000/05/02 19:22:01 aruna1 Exp $
  58.  *
  59. */
  60. #ifndef DOM_XMLDecl_HEADER_GUARD_
  61. #define DOM_XMLDecl_HEADER_GUARD_
  62. #include <util/XercesDefs.hpp>
  63. #include "dom/DOM_Node.hpp"
  64. class XMLDeclImpl;
  65. /**
  66. * Class to refer to XML Declaration nodes in the DOM.
  67. *
  68. */
  69. class CDOM_EXPORT DOM_XMLDecl: public DOM_Node {
  70. public:
  71.     /** @name Constructors and assignment operators */
  72.     //@{
  73.     /**
  74.      * The default constructor for DOM_XMLDecl creates a null
  75.      * DOM_XMLDecl object that refers to a declaration node with 
  76.      * version= 1.0, encoding=utf-8 and standalone=no
  77.      *
  78.      */
  79.     DOM_XMLDecl();
  80.     /**
  81.       * Copy constructor.  Creates a new <code>DOM_XMLDecl</code> that refers to the
  82.       * same underlying actual xmlDecl node as the original.
  83.       *
  84.       * @param other The object to be copied
  85.       */
  86.     DOM_XMLDecl(const DOM_XMLDecl &other);
  87.     /**
  88.       * Assignment operator
  89.       *
  90.       * @param other The object to be copied
  91.       */
  92.     DOM_XMLDecl & operator = (const DOM_XMLDecl &other);
  93.     /**
  94.       * Assignment operator.  This overloaded variant is provided for
  95.       *   the sole purpose of setting a DOM_Node reference variable to
  96.       *   zero.  Nulling out a reference variable in this way will decrement
  97.       *   the reference count on the underlying Node object that the variable
  98.       *   formerly referenced.  This effect is normally obtained when reference
  99.       *   variable goes out of scope, but zeroing them can be useful for
  100.       *   global instances, or for local instances that will remain in scope
  101.       *   for an extended time,  when the storage belonging to the underlying
  102.       *   node needs to be reclaimed.
  103.       *
  104.       * @param val.  Only a value of 0, or null, is allowed.
  105.       */
  106.     DOM_XMLDecl & operator = (const DOM_NullPtr *val);
  107. //@}
  108.   /** @name Destructor */
  109.   //@{
  110.   /**
  111.     * Destructor.  The object being destroyed is the reference
  112.     * object, not the underlying Document itself.
  113.     *
  114.     * <p>The reference counting memory management will
  115.     *  delete the underlying document itself if this
  116.     * DOM_XMLDecl is the last remaining to refer to the Document,
  117.     * and if there are no remaining references to any of the nodes
  118.     * within the document tree.  If other live references do remain,
  119.     * the underlying document itself remains also.
  120.     *
  121.     */
  122.     ~DOM_XMLDecl();
  123.   //@}
  124.     //@{
  125.   
  126.   /**
  127.     * To get the version string of the xmlDeclaration statement
  128.     */
  129.     DOMString getVersion() const;
  130.   
  131.   /**
  132.     * To get the encoding string of the xmlDeclaration statement
  133.     */
  134.     DOMString getEncoding() const;
  135.   
  136.   /**
  137.     * To get the standalone string of the xmlDeclaration statement
  138.     */
  139.     DOMString getStandalone() const;
  140.    //@}
  141.     
  142. protected:
  143.     DOM_XMLDecl( XMLDeclImpl *impl);
  144.     friend class DOM_Document;
  145. };
  146. #endif