DOMException.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:9k
源码类别:

词法分析

开发平台:

Visual C++

  1. #ifndef DOMException_HEADER_GUARD_
  2. #define DOMException_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 2001, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Id: DOMException.hpp,v 1.5 2002/11/04 15:09:24 tng Exp $
  60.  */
  61. #include <xercesc/util/XercesDefs.hpp>
  62. XERCES_CPP_NAMESPACE_BEGIN
  63. /**
  64.  * DOM operations only raise exceptions in "exceptional" circumstances, i.e.,
  65.  * when an operation is impossible to perform (either for logical reasons,
  66.  * because data is lost, or because the implementation has become unstable).
  67.  * In general, DOM methods return specific error values in ordinary
  68.  * processing situations, such as out-of-bound errors when using
  69.  * <code>DOMNodeList</code>.
  70.  * <p>Implementations should raise other exceptions under other circumstances.
  71.  * For example, implementations should raise an implementation-dependent
  72.  * exception if a <code>null</code> argument is passed.
  73.  * <p>Some languages and object systems do not support the concept of
  74.  * exceptions. For such systems, error conditions may be indicated using
  75.  * native error reporting mechanisms. For some bindings, for example,
  76.  * methods may return error codes similar to those listed in the
  77.  * corresponding method descriptions.
  78.  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
  79.  * @since DOM Level 1
  80.  */
  81. class CDOM_EXPORT DOMException  {
  82. public:
  83.     // -----------------------------------------------------------------------
  84.     //  Constructors
  85.     // -----------------------------------------------------------------------
  86.     /** @name Constructors */
  87.     //@{
  88.     /**
  89.       * Default constructor for DOMException.
  90.       *
  91.       */
  92.     DOMException();
  93.     /**
  94.       * Constructor which takes an error code and a message.
  95.       *
  96.       * @param code The error code which indicates the exception
  97.       * @param message The string containing the error message
  98.       */
  99.     DOMException(short code, const XMLCh *message);
  100.     /**
  101.       * Copy constructor.
  102.       *
  103.       * @param other The object to be copied.
  104.       */
  105.     DOMException(const DOMException &other);
  106.     //@}
  107.     // -----------------------------------------------------------------------
  108.     //  Destructors
  109.     // -----------------------------------------------------------------------
  110.     /** @name Destructor. */
  111.     //@{
  112.  /**
  113.   * Destructor for DOMException.
  114.   *
  115.   */
  116.     virtual ~DOMException();
  117.     //@}
  118. public:
  119.     // -----------------------------------------------------------------------
  120.     //  Class Types
  121.     // -----------------------------------------------------------------------
  122.     /** @name Public Contants */
  123.     //@{
  124.     /**
  125.      * ExceptionCode
  126.      *
  127.      * <p><code>INDEX_SIZE_ERR:</code>
  128.      * If index or size is negative, or greater than the allowed value.</p>
  129.      *
  130.      * <p><code>DOMSTRING_SIZE_ERR:</code>
  131.      * If the specified range of text does not fit into a DOMString.</p>
  132.      *
  133.      * <p><code>HIERARCHY_REQUEST_ERR:</code>
  134.      * If any node is inserted somewhere it doesn't belong.</p>
  135.      *
  136.      * <p><code>WRONG_DOCUMENT_ERR:</code>
  137.      * If a node is used in a different document than the one that created it
  138.      * (that doesn't support it).</p>
  139.      *
  140.      * <p><code>INVALID_CHARACTER_ERR:</code>
  141.      * If an invalid or illegal character is specified, such as in a name. See
  142.      * production 2 in the XML specification for the definition of a legal
  143.      * character, and production 5 for the definition of a legal name
  144.      * character.</p>
  145.      *
  146.      * <p><code>NO_DATA_ALLOWED_ERR:</code>
  147.      * If data is specified for a node which does not support data.</p>
  148.      *
  149.      * <p><code>NO_MODIFICATION_ALLOWED_ERR:</code>
  150.      * If an attempt is made to modify an object where modifications are not
  151.      * allowed.</p>
  152.      *
  153.      * <p><code>NOT_FOUND_ERR:</code>
  154.      * If an attempt is made to reference a node in a context where it does
  155.      * not exist.</p>
  156.      *
  157.      * <p><code>NOT_SUPPORTED_ERR:</code>
  158.      * If the implementation does not support the requested type of object or
  159.      * operation.</p>
  160.      *
  161.      * <p><code>INUSE_ATTRIBUTE_ERR:</code>
  162.      * If an attempt is made to add an attribute that is already in use
  163.      * elsewhere.</p>
  164.      *
  165.      * The above are since DOM Level 1
  166.      * @since DOM Level 1
  167.      *
  168.      * <p><code>INVALID_STATE_ERR:</code>
  169.      * If an attempt is made to use an object that is not, or is no longer,
  170.      * usable.</p>
  171.      *
  172.      * <p><code>SYNTAX_ERR:</code>
  173.      * If an invalid or illegal string is specified.</p>
  174.      *
  175.      * <p><code>INVALID_MODIFICATION_ERR:</code>
  176.      * If an attempt is made to modify the type of the underlying object.</p>
  177.      *
  178.      * <p><code>NAMESPACE_ERR:</code>
  179.      * If an attempt is made to create or change an object in a way which is
  180.      * incorrect with regard to namespaces.</p>
  181.      *
  182.      * <p><code>INVALID_ACCESS_ERR:</code>
  183.      * If a parameter or an operation is not supported by the underlying
  184.      * object.
  185.      *
  186.      * The above are since DOM Level 2
  187.      * @since DOM Level 2
  188.      *
  189.      * <p><code>VALIDATION_ERR:</code>
  190.      * If a call to a method such as <code>insertBefore</code> or
  191.      * <code>removeChild</code> would make the <code>Node</code> invalid
  192.      * with respect to "partial validity", this exception would be raised
  193.      * and the operation would not be done.
  194.      *
  195.      * The above is since DOM Level 2
  196.      * @since DOM Level 3
  197.      */
  198.     enum ExceptionCode {
  199.          INDEX_SIZE_ERR       = 1,
  200.          DOMSTRING_SIZE_ERR   = 2,
  201.          HIERARCHY_REQUEST_ERR = 3,
  202.          WRONG_DOCUMENT_ERR   = 4,
  203.          INVALID_CHARACTER_ERR = 5,
  204.          NO_DATA_ALLOWED_ERR  = 6,
  205.          NO_MODIFICATION_ALLOWED_ERR = 7,
  206.          NOT_FOUND_ERR        = 8,
  207.          NOT_SUPPORTED_ERR    = 9,
  208.          INUSE_ATTRIBUTE_ERR  = 10,
  209.          INVALID_STATE_ERR    = 11,
  210.          SYNTAX_ERR     = 12,
  211.          INVALID_MODIFICATION_ERR    = 13,
  212.          NAMESPACE_ERR     = 14,
  213.          INVALID_ACCESS_ERR   = 15,
  214.          VALIDATION_ERR       = 16
  215.         };
  216.     //@}
  217.     // -----------------------------------------------------------------------
  218.     //  Class Types
  219.     // -----------------------------------------------------------------------
  220.     /** @name Public variables */
  221.     //@{
  222.  /**
  223.   * A code value, from the set defined by the ExceptionCode enum,
  224.      * indicating the type of error that occured.
  225.      */
  226.     ExceptionCode   code;
  227.  /**
  228.   * A string value.  Applications may use this field to hold an error
  229.      *  message.  The field value is not set by the DOM implementation,
  230.      *  meaning that the string will be empty when an exception is first
  231.      *  thrown.
  232.   */
  233.     const XMLCh *msg;
  234.     //@}
  235. };
  236. XERCES_CPP_NAMESPACE_END
  237. #endif