ACE/ACEXML/common/Exception.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Exception.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef _ACEXML_EXCEPTION_H_
  12 #define _ACEXML_EXCEPTION_H_
  13
  14 #include /**/ "ace/pre.h"
  15 #include "ACEXML/common/ACEXML_Export.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 #pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "ACEXML/common/XML_Types.h"
  22
  23 /**
  24  * @class ACEXML_Exception
  25  *
  26  * @brief ACEXML_Exception
  27  *
  28  * ACEXML_Exception is the base class for all ACEXML related exceptions.
  29  * Since ACEXML currently does not support native exceptions, all
  30  * exceptions should be thrown thru ACEXML_Env.
  31  *
  32  * @sa ACEXML_Env
  33  */
  34 class ACEXML_Export ACEXML_Exception
  35 {
  36 public:
  37   /// Destructor.
  38   virtual ~ACEXML_Exception ();
  39
  40   /// Throw the exception.
  41   virtual void _raise () = 0;
  42
  43   /// Static narrow operation.
  44   static ACEXML_Exception* _downcast (ACEXML_Exception* ex);
  45
  46   /// Return the exception type.  (for safe downcast.)
  47   virtual const ACEXML_Char *id () const ;
  48
  49   /// Dynamically create a copy of this exception.
  50   virtual ACEXML_Exception *duplicate () const = 0;
  51
  52   /// Check whether this is an exception of type specified by <name>.
  53   virtual int is_a (const ACEXML_Char *name);
  54
  55   /// Print out exception using ACE_DEBUG.
  56   virtual void print () const = 0;
  57
  58 protected:
  59   /// Default constructor.
  60   ACEXML_Exception ();
  61
  62   /// All exceptions have names.  This name is used to identify the
  63   /// type of an exception.
  64   static const ACEXML_Char *exception_name_;
  65
  66   /// A null string that we return when there is no exception.
  67   static const ACEXML_Char *null_;
  68 };
  69
  70 #if defined (__ACEXML_INLINE__)
  71 # include "ACEXML/common/Exception.inl"
  72 #endif /* __ACEXML_INLINE__ */
  73
  74 #include /**/ "ace/post.h"
  75
  76 #endif /* _ACEXML_EXCEPTION_H_ */