xercesc/dom/DOMErrorHandler.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_DOMERRORHANDLER_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMERRORHANDLER_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026
0027 XERCES_CPP_NAMESPACE_BEGIN
0028
0029
0030 class DOMError;
0031
0032 /**
0033   * Basic interface for DOM error handlers.
0034   *
0035   * <p>DOMErrorHandler is a callback interface that the DOM implementation
0036   * can call when reporting errors that happens while processing XML data, or
0037   * when doing some other processing (e.g. validating a document).</p>
0038   *
0039   * <p>The application that is using the DOM implementation is expected to
0040   * implement this interface.</p>
0041   *
0042   * @see DOMLSParser#getDomConfig
0043   * @since DOM Level 3
0044   */
0045
0046 class CDOM_EXPORT DOMErrorHandler
0047 {
0048 protected:
0049     // -----------------------------------------------------------------------
0050     //  Hidden constructors
0051     // -----------------------------------------------------------------------
0052     /** @name Hidden constructors */
0053     //@{
0054     DOMErrorHandler() {};
0055     //@}
0056
0057 private:
0058     // -----------------------------------------------------------------------
0059     // Unimplemented constructors and operators
0060     // -----------------------------------------------------------------------
0061     /** @name Unimplemented constructors and operators */
0062     //@{
0063     DOMErrorHandler(const DOMErrorHandler &);
0064     DOMErrorHandler & operator = (const DOMErrorHandler &);
0065     //@}
0066
0067 public:
0068     // -----------------------------------------------------------------------
0069     //  All constructors are hidden, just the destructor is available
0070     // -----------------------------------------------------------------------
0071     /** @name Destructor */
0072     //@{
0073     /**
0074      * Destructor
0075      *
0076      */
0077     virtual ~DOMErrorHandler() {};
0078     //@}
0079
0080     // -----------------------------------------------------------------------
0081     //  Virtual DOMErrorHandler interface
0082     // -----------------------------------------------------------------------
0083     /** @name Functions introduced in DOM Level 3 */
0084     //@{
0085     /**
0086      * This method is called on the error handler when an error occurs.
0087      * If an exception is thrown from this method, it is considered to be equivalent of returning <code>true</code>.
0088      *
0089      * @param domError The error object that describes the error, this object
0090      *                 may be reused by the DOM implementation across multiple
0091      *                 calls to the handleError method.
0092      * @return If the handleError method returns <code>true</code> the DOM
0093      *         implementation should continue as if the error didn't happen
0094      *         when possible, if the method returns <code>false</code> then the
0095      *         DOM implementation should stop the current processing when
0096      *         possible.
0097      *
0098      * @since DOM Level 3
0099      */
0100     virtual bool handleError(const DOMError& domError) = 0;
0101     //@}
0102
0103 };
0104
0105 XERCES_CPP_NAMESPACE_END
0106
0107 #endif