1 /*

     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description: 

    15 *

    16 */

    17 #ifndef DOMErrorHandler_HEADER_GUARD_

    18 #define DOMErrorHandler_HEADER_GUARD_

    19 

    20 /*

    21  * Licensed to the Apache Software Foundation (ASF) under one or more

    22  * contributor license agreements.  See the NOTICE file distributed with

    23  * this work for additional information regarding copyright ownership.

    24  * The ASF licenses this file to You under the Apache License, Version 2.0

    25  * (the "License"); you may not use this file except in compliance with

    26  * the License.  You may obtain a copy of the License at

    27  * 

    28  *      http://www.apache.org/licenses/LICENSE-2.0

    29  * 

    30  * Unless required by applicable law or agreed to in writing, software

    31  * distributed under the License is distributed on an "AS IS" BASIS,

    32  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    33  * See the License for the specific language governing permissions and

    34  * limitations under the License.

    35  */

    36 

    37 /*

    38  * $Id: DOMErrorHandler.hpp 568078 2007-08-21 11:43:25Z amassari $

    39  */

    40 

    41 

    42 #include <xercesc/util/XercesDefs.hpp>

    43 

    44 XERCES_CPP_NAMESPACE_BEGIN

    45 

    46 

    47 class DOMError;

    48 

    49 /**

    50   * Basic interface for DOM error handlers.

    51   *

    52   * <p>DOMErrorHandler is a callback interface that the DOM implementation

    53   * can call when reporting errors that happens while processing XML data, or

    54   * when doing some other processing (e.g. validating a document).</p>

    55   *

    56   * <p>The application that is using the DOM implementation is expected to

    57   * implement this interface.</p>

    58   *

    59   * @see DOMBuilder#setErrorHandler

    60   * @since DOM Level 3

    61   */

    62 

    63 class CDOM_EXPORT DOMErrorHandler

    64 {

    65 protected:

    66     // -----------------------------------------------------------------------

    67     //  Hidden constructors

    68     // -----------------------------------------------------------------------

    69     /** @name Hidden constructors */

    70     //@{    

    71     DOMErrorHandler() {};

    72     //@}

    73 

    74 private:

    75     // -----------------------------------------------------------------------

    76     // Unimplemented constructors and operators

    77     // -----------------------------------------------------------------------

    78     /** @name Unimplemented constructors and operators */

    79     //@{

    80     DOMErrorHandler(const DOMErrorHandler &);

    81     DOMErrorHandler & operator = (const DOMErrorHandler &);

    82     //@}

    83 

    84 public:

    85     // -----------------------------------------------------------------------

    86     //  All constructors are hidden, just the destructor is available

    87     // -----------------------------------------------------------------------

    88     /** @name Destructor */

    89     //@{

    90     /**

    91      * Destructor

    92      *

    93      */

    94     virtual ~DOMErrorHandler() {};

    95     //@}

    96 

    97     // -----------------------------------------------------------------------

    98     //  Virtual DOMErrorHandler interface

    99     // -----------------------------------------------------------------------

   100     /** @name Functions introduced in DOM Level 3 */

   101     //@{

   102     /**

   103      * This method is called on the error handler when an error occures.

   104      *

   105      * <p><b>"Experimental - subject to change"</b></p>

   106      *

   107      * @param domError The error object that describes the error, this object

   108      *                 may be reused by the DOM implementation across multiple

   109      *                 calls to the handleEvent method.

   110      * @return If the handleError method returns <code>true</code> the DOM

   111      *         implementation should continue as if the error didn't happen

   112      *         when possible, if the method returns <code>false</code> then the

   113      *         DOM implementation should stop the current processing when

   114      *         possible.

   115      *

   116      * @since DOM Level 3

   117      */

   118     virtual bool handleError(const DOMError& domError) = 0;

   119     //@}

   120 

   121 };

   122 

   123 XERCES_CPP_NAMESPACE_END

   124 

   125 #endif