xercesc/dom/DOMXPathException.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_DOMXPATHEXCEPTION_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMXPATHEXCEPTION_HPP
0024
0025 #include <xercesc/dom/DOMException.hpp>
0026
0027 XERCES_CPP_NAMESPACE_BEGIN
0028
0029 /**
0030  * @since DOM Level 3
0031  */
0032 class CDOM_EXPORT DOMXPathException : public DOMException
0033 {
0034 public:
0035     //@{
0036     /**
0037      * ExceptionCode
0038      * <br>INVALID_EXPRESSION_ERR The expression has a syntax error or otherwise
0039      * is not a legal expression according to the rules of the specific
0040      * <code>DOMXPathEvaluator</code> or contains specialized extension functions
0041      * or variables not supported by this implementation.
0042      * <br>TYPE_ERR The expression cannot be converted to return the specified type.
0043      * <br>NO_RESULT_ERROR There is no current result in the result object.
0044      */
0045     enum ExceptionCode {
0046         INVALID_EXPRESSION_ERR = 51,
0047         TYPE_ERR = 52,
0048                 NO_RESULT_ERROR = 53
0049     };
0050     //@}
0051
0052 public:
0053     // -----------------------------------------------------------------------
0054     //  Constructors
0055     // -----------------------------------------------------------------------
0056     /** @name Constructors */
0057     //@{
0058     /**
0059       * Default constructor for DOMXPathException.
0060       *
0061       */
0062     DOMXPathException();
0063
0064     /**
0065       * Constructor which takes an error code and a message.
0066       *
0067       * @param code The error code which indicates the exception
0068       * @param messageCode    The string containing the error message
0069       * @param memoryManager  The memory manager used to (de)allocate memory
0070       */
0071     DOMXPathException(short code,
0072                       short messageCode = 0,
0073                       MemoryManager* const  memoryManager = XMLPlatformUtils::fgMemoryManager);
0074
0075     /**
0076       * Copy constructor.
0077       *
0078       * @param other The object to be copied.
0079       */
0080     DOMXPathException(const DOMXPathException  &other);
0081
0082     //@}
0083
0084     // -----------------------------------------------------------------------
0085     //  Destructors
0086     // -----------------------------------------------------------------------
0087     /** @name Destructor. */
0088     //@{
0089      /**
0090       * Destructor for DOMXPathException.
0091       *
0092       */
0093     virtual ~DOMXPathException();
0094     //@}
0095
0096 private:
0097     // -----------------------------------------------------------------------
0098     // Unimplemented constructors and operators
0099     // -----------------------------------------------------------------------
0100     DOMXPathException& operator = (const DOMXPathException&);
0101 };
0102
0103 XERCES_CPP_NAMESPACE_END
0104
0105 #endif