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

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.  * $Log: DOM_EntityReference.hpp,v $
  58.  * Revision 1.5  2000/03/02 19:53:56  roddey
  59.  * This checkin includes many changes done while waiting for the
  60.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  61.  * available elsewhere.
  62.  *
  63.  * Revision 1.4  2000/02/24 20:11:28  abagchi
  64.  * Swat for removing Log from API docs
  65.  *
  66.  * Revision 1.3  2000/02/06 07:47:30  rahulj
  67.  * Year 2K copyright swat.
  68.  *
  69.  * Revision 1.2  2000/01/05 01:16:07  andyh
  70.  * DOM Level 2 core, namespace support added.
  71.  *
  72.  * Revision 1.1.1.1  1999/11/09 01:08:58  twl
  73.  * Initial checkin
  74.  *
  75.  * Revision 1.2  1999/11/08 20:44:18  rahul
  76.  * Swat for adding in Product name and CVS comment log variable.
  77.  *
  78.  */
  79. #ifndef DOM_EntityReference_HEADER_GUARD_
  80. #define DOM_EntityReference_HEADER_GUARD_
  81. #include <util/XercesDefs.hpp>
  82. #include <dom/DOM_Node.hpp>
  83. class EntityReferenceImpl;
  84. /**
  85.  * <code>EntityReference</code> nodes will appear in the structure 
  86.  * model when an entity reference is in the source document, or when the user 
  87.  * wishes to insert an entity reference. 
  88.  *
  89.  * The expansion of the entity will appear as child nodes of the entity
  90.  * reference node.  The expansion may be just simple text, or it may
  91.  * be more complex, containing additional entity refs.
  92.  *
  93. */
  94. class CDOM_EXPORT DOM_EntityReference: public DOM_Node {
  95. public:
  96.     /** @name Constructors and assignment operator */
  97.     //@{
  98.     /**
  99.       * Default constructor for DOM_EntityReference.  The resulting object does not
  100.     * refer to an actual Entity Reference node; it will compare == to 0, and is similar
  101.     * to a null object reference variable in Java.  It may subsequently be
  102.     * assigned to refer to an actual entity reference node.
  103.     * <p>
  104.     * New entity reference nodes are created by DOM_Document::createEntityReference().
  105.       *
  106.       */
  107.     DOM_EntityReference();
  108.     /**
  109.       * Copy constructor.  Creates a new <code>DOM_EntityReference</code> that refers to the
  110.     * same underlying node as the original.  
  111.       *
  112.       * @param other The object to be copied.
  113.       */
  114.     DOM_EntityReference(const DOM_EntityReference &other);
  115.     /**
  116.       * Assignment operator.
  117.       *
  118.       * @param other The object to be copied.
  119.       */
  120.     DOM_EntityReference & operator = (const DOM_EntityReference &other);
  121.     /**
  122.       * Assignment operator.  This overloaded variant is provided for
  123.       *   the sole purpose of setting a DOM_Node reference variable to
  124.       *   zero.  Nulling out a reference variable in this way will decrement
  125.       *   the reference count on the underlying Node object that the variable
  126.       *   formerly referenced.  This effect is normally obtained when reference
  127.       *   variable goes out of scope, but zeroing them can be useful for
  128.       *   global instances, or for local instances that will remain in scope
  129.       *   for an extended time,  when the storage belonging to the underlying
  130.       *   node needs to be reclaimed.
  131.       *
  132.       * @param val.  Only a value of 0, or null, is allowed.
  133.       */
  134.     DOM_EntityReference & operator = (const DOM_NullPtr *val);
  135.     //@}
  136.     /** @name Destructor. */
  137.     //@{
  138.  /**
  139.   * Destructor for DOM_EntityReference.  The object being destroyed is the reference
  140.       * object, not the underlying entity reference node itself.
  141.   *
  142.   */
  143.     ~DOM_EntityReference();
  144.     //@}
  145. protected:
  146.     DOM_EntityReference(EntityReferenceImpl *impl);
  147.     friend class DOM_Document;
  148. };
  149. #endif