diagnostic_handler.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2006-2008 The FLWOR Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef ZORBA_DIAGNOSTIC_HANDLER_API_H
00018 #define ZORBA_DIAGNOSTIC_HANDLER_API_H
00019 
00020 #include <zorba/config.h>
00021 
00022 #include <zorba/xquery_warning.h>
00023 
00024 namespace zorba {
00025 
00026 /**
00027  * When registered with an XQuery object, a %DiagnosticHandler handles all
00028  * exceptions and warnings that otherwise would have been thrown or reported.
00029  */
00030 class ZORBA_DLL_PUBLIC DiagnosticHandler {
00031 public:
00032   virtual ~DiagnosticHandler();
00033 
00034   /**
00035    * This function is called for all exceptions.
00036    *
00037    * @param exception The exception.
00038    */
00039   virtual void error( ZorbaException const &exception );
00040 
00041   /**
00042    * This function is called for all warnings.
00043    *
00044    * @param warning The warning.
00045    */
00046   virtual void warning( XQueryWarning const &warning );
00047 };
00048 
00049 } // namespace zorba
00050 
00051 #endif /* ZORBA_DIAGNOSTIC_HANDLER_API_H */
00052 /* vim:set et sw=2 ts=2: */
blog comments powered by Disqus