Logo Search packages:      
Sourcecode: poco version File versions  Download package

DOMException.h

//
// DOMException.h
//
// $Id: //poco/1.2/XML/include/Poco/DOM/DOMException.h#1 $
//
// Library: XML
// Package: DOM
// Module:  DOM
//
// Definition of the DOM DOMException class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef DOM_DOMException_INCLUDED
#define DOM_DOMException_INCLUDED


#include "Poco/XML/XML.h"
#include "Poco/XML/XMLException.h"


namespace Poco {
namespace XML {


00051 class XML_API DOMException: public XMLException
      /// DOM operations only raise exceptions in "exceptional" circumstances, i.e.,
      /// when an operation is impossible to perform (either for logical reasons,
      /// because data is lost, or because the implementation has become unstable).
      /// In general, DOM methods return specific error values in ordinary processing
      /// situations, such as out-of-bound errors when using NodeList.
      /// 
      /// Implementations should raise other exceptions under other circumstances.
      /// For example, implementations should raise an implementation-dependent exception
      /// if a null argument is passed when null was not expected.
{
public:
      enum
      {
            INDEX_SIZE_ERR = 1,          /// index or size is negative or greater than allowed value
00066             DOMSTRING_SIZE_ERR,          /// the specified range of text does not fit into a DOMString (not used)
00067             HIERARCHY_REQUEST_ERR,       /// a node is inserted somewhere it doesn't belong
00068             WRONG_DOCUMENT_ERR,          /// a node is used in a different document than the one that created it
00069             INVALID_CHARACTER_ERR,       /// an invalid character is specified (not used)
00070             NO_DATA_ALLOWED_ERR,         /// data is specified for a node which does not support data
00071             NO_MODIFICATION_ALLOWED_ERR, /// an attempt is made to modify an object where modifications are not allowed
00072             NOT_FOUND_ERR,               /// an attempt was made to reference a node in a context where it does not exist
00073             NOT_SUPPORTED_ERR,           /// the implementation does not support the type of object requested
00074             INUSE_ATTRIBUTE_ERR,         /// an attempt is made to add an attribute that is already in use elsewhere
00075             INVALID_STATE_ERR,           /// a parameter or an operation is not supported by the underlying object
00076             SYNTAX_ERR,                  /// an invalid or illegal string is specified
00077             INVALID_MODIFICATION_ERR,    /// an attempt is made to modify the type of the underlying object
00078             NAMESPACE_ERR,               /// an attempt is made to create or change an object in a way which is incorrect with regard to namespaces
00079             INVALID_ACCESS_ERR,          /// an attempt is made to use an object that is not, or is no longer, usable
            
00081             _NUMBER_OF_MESSAGES
      };

      DOMException(unsigned short code);
            /// Creates a DOMException with the given error code.
            
      DOMException(const DOMException& exc);
            /// Creates a DOMException by copying another one.
            
      ~DOMException() throw();
            /// Destroys the DOMException.
            
      DOMException& operator = (const DOMException& exc);

      const char* name() const throw();
            /// Returns a static string describing the exception.

      const char* className() const throw();
            /// Returns the name of the exception class.

      Poco::Exception* clone() const;
            /// Creates an exact copy of the exception.
            
      void rethrow() const;
            /// (Re)Throws the exception.

      unsigned short code() const;
            /// Returns the DOM exception code.

protected:
      static const std::string& message(unsigned short code);
      
private:
      DOMException();
      
      unsigned short _code;
      
      static const std::string MESSAGES[_NUMBER_OF_MESSAGES];
};


//
// inlines
//
00125 inline unsigned short DOMException::code() const
{
      return _code;
}


} } // namespace Poco::XML


#endif // DOM_DOMException_INCLUDED

Generated by  Doxygen 1.6.0   Back to index