DOM_DOMException.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_DOMException.hpp,v $
  58.  * Revision 1.7  2000/03/02 19:53:54  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.6  2000/02/24 20:11:27  abagchi
  64.  * Swat for removing Log from API docs
  65.  *
  66.  * Revision 1.5  2000/02/10 19:52:08  abagchi
  67.  * Added docs for enum
  68.  *
  69.  * Revision 1.4  2000/02/06 07:47:28  rahulj
  70.  * Year 2K copyright swat.
  71.  *
  72.  * Revision 1.3  2000/02/04 05:46:31  andyh
  73.  * Change offsets and lengths form signed to unsigned
  74.  *
  75.  * Revision 1.2  2000/01/05 01:16:06  andyh
  76.  * DOM Level 2 core, namespace support added.
  77.  *
  78.  * Revision 1.1.1.1  1999/11/09 01:08:53  twl
  79.  * Initial checkin
  80.  *
  81.  * Revision 1.3  1999/11/08 20:44:14  rahul
  82.  * Swat for adding in Product name and CVS comment log variable.
  83.  *
  84.  */
  85. #ifndef DOMException_HEADER_GUARD_
  86. #define DOMException_HEADER_GUARD_
  87. #include <util/XercesDefs.hpp>
  88. #include <dom/DOMString.hpp>
  89. /**
  90.   * Encapsulate a general DOM error or warning.
  91.   *
  92.   * <p> The DOM will create and throw an instance of DOMException
  93.   * when an error condition is detected.  Exceptions can occur
  94.   * when an application directly manipulates the DOM document
  95.   * tree that is produced by the parser, or when a document tree
  96.   * is created from scratch using the DOM API.  DOM exceptions will
  97.   * not be generated by the parser while constructing a document
  98.   * tree from an XML source document.
  99.   *
  100.   * <p>Unlike the other classes in the C++ DOM API, DOM_DOMException
  101.   * is NOT a reference to an underlying implementation class, and
  102.   * does not provide automatic memory management.  Code that catches
  103.   * a DOM exception is responsible for deleting it, or otherwise
  104.   * arranging for its disposal.
  105.   *
  106.   */
  107. class CDOM_EXPORT DOM_DOMException  {
  108. public:
  109.     /** @name Enumerators for DOM Exceptions */
  110.     //@{
  111.         enum ExceptionCode {
  112.                 INDEX_SIZE_ERR       = 1,
  113.                 DOMSTRING_SIZE_ERR   = 2,
  114.                 HIERARCHY_REQUEST_ERR = 3,
  115.                 WRONG_DOCUMENT_ERR   = 4,
  116.                 INVALID_CHARACTER_ERR = 5,
  117.                 NO_DATA_ALLOWED_ERR  = 6,
  118.                 NO_MODIFICATION_ALLOWED_ERR = 7,
  119.                 NOT_FOUND_ERR        = 8,
  120.                 NOT_SUPPORTED_ERR    = 9,
  121.                 INUSE_ATTRIBUTE_ERR  = 10,
  122.                 INVALID_STATE_ERR    = 11,
  123.         SYNTAX_ERR      = 12,
  124.          INVALID_MODIFICATION_ERR    = 13,
  125.          NAMESPACE_ERR      = 14,
  126.          INVALID_ACCESS_ERR   = 15
  127.         };
  128.     //@}
  129. public:
  130.     /** @name Constructors and assignment operator */
  131.     //@{
  132.     /**
  133.       * Default constructor for DOM_DOMException.
  134.       *
  135.       */
  136.     DOM_DOMException();
  137.     /**
  138.       * Constructor which takes an error code and a message.
  139.       *
  140.       * @param code The error code which indicates the exception
  141.       * @param message The string containing the error message
  142.       */
  143.     DOM_DOMException(short code, const DOMString &message);
  144.     /**
  145.       * Copy constructor.
  146.       *
  147.       * @param other The object to be copied.
  148.       */
  149.     DOM_DOMException(const DOM_DOMException &other);
  150.     //@}
  151.     /** @name Destructor. */
  152.     //@{
  153.  /**
  154.   * Destructor for DOM_DOMException.  Applications are responsible
  155.       * for deleting DOM_Exception objects that they catch after they
  156.       * have completed their exception processing.
  157.   *
  158.   */
  159.     virtual ~DOM_DOMException();
  160.     //@}
  161.     /** @name Public variables. */
  162.      //@{
  163.  /**
  164.   * A code value, from the set defined by the ExceptionCode enum,
  165.       * indicating the type of error that occured.
  166.   */
  167.    ExceptionCode   code;
  168.  /**
  169.   * A string value.  Applications may use this field to hold an error
  170.       *  message.  The field value is not set by the DOM implementation,
  171.       *  meaning that the string will be empty when an exception is first
  172.       *  thrown.
  173.   */
  174.     DOMString msg;
  175.     //@}
  176. };
  177. #endif