xercesc/dom/DOMRangeException.hpp

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *      http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 /*
0019  * $Id$
0020  */
0021
0022 #if !defined(XERCESC_INCLUDE_GUARD_DOMRANGEEXCEPTION_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMRANGEEXCEPTION_HPP
0024
0025 #include <xercesc/dom/DOMException.hpp>
0026
0027 XERCES_CPP_NAMESPACE_BEGIN
0028
0029 /**
0030  * Range operations may throw a <code>DOMRangeException</code> as specified in
0031  * their method descriptions.
0032  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.
0033  * @since DOM Level 2
0034  */
0035
0036 class CDOM_EXPORT DOMRangeException  : public DOMException {
0037 public:
0038     // -----------------------------------------------------------------------
0039     //  Class Types
0040     // -----------------------------------------------------------------------
0041     /** @name Public Constants */
0042     //@{
0043     /**
0044      * Enumerators for DOM Range Exceptions
0045      *
0046      * <p><code>BAD_BOUNDARYPOINTS_ERR:</code>
0047      * If the boundary-points of a Range do not meet specific requirements.</p>
0048      *
0049      * <p><code>INVALID_NODE_TYPE_ERR:</code>
0050      * If the container of an boundary-point of a Range is being set to either
0051      * a node of an invalid type or a node with an ancestor of an invalid
0052      * type.</p>
0053      *
0054      * @since DOM Level 2
0055      */
0056         enum RangeExceptionCode {
0057                 BAD_BOUNDARYPOINTS_ERR  = 111,
0058                 INVALID_NODE_TYPE_ERR   = 112
0059         };
0060     //@}
0061
0062 public:
0063     // -----------------------------------------------------------------------
0064     //  Constructors
0065     // -----------------------------------------------------------------------
0066     /** @name Constructors */
0067     //@{
0068     /**
0069       * Default constructor for DOMRangeException.
0070       *
0071       */
0072     DOMRangeException();
0073
0074     /**
0075       * Constructor which takes an error code and a message.
0076       *
0077       * @param code           The error code which indicates the exception
0078       * @param messageCode    The string containing the error message
0079       * @param memoryManager  The memory manager used to (de)allocate memory
0080       */
0081     DOMRangeException(short code,
0082                       short messageCode,
0083                       MemoryManager*     const memoryManager);
0084
0085     /**
0086       * Copy constructor.
0087       *
0088       * @param other The object to be copied.
0089       */
0090     DOMRangeException(const DOMRangeException &other);
0091     //@}
0092
0093     // -----------------------------------------------------------------------
0094     //  Destructors
0095     // -----------------------------------------------------------------------
0096     /** @name Destructor. */
0097     //@{
0098      /**
0099       * Destructor for DOMRangeException.
0100       *
0101       */
0102     virtual ~DOMRangeException();
0103     //@}
0104
0105 private:
0106     // -----------------------------------------------------------------------
0107     // Unimplemented constructors and operators
0108     // -----------------------------------------------------------------------
0109     DOMRangeException & operator = (const DOMRangeException &);
0110 };
0111
0112 XERCES_CPP_NAMESPACE_END
0113
0114 #endif