DOMError.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_DOMERROR_HPP)
#define XERCESC_INCLUDE_GUARD_DOMERROR_HPP
#include <xercesc/util/XercesDefs.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class DOMLocator;
class CDOM_EXPORT DOMError
{
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
DOMError() {};
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
DOMError(const DOMError &);
DOMError & operator = (const DOMError &);
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
virtual ~DOMError() {};
// -----------------------------------------------------------------------
// Class types
// -----------------------------------------------------------------------
enum ErrorSeverity
{
DOM_SEVERITY_WARNING = 1,
DOM_SEVERITY_ERROR = 2,
DOM_SEVERITY_FATAL_ERROR = 3
};
// -----------------------------------------------------------------------
// Virtual DOMError interface
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
virtual ErrorSeverity getSeverity() const = 0;
virtual const XMLCh* getMessage() const = 0;
virtual DOMLocator* getLocation() const = 0;
virtual void* getRelatedException() const = 0;
virtual const XMLCh* getType() const = 0;
virtual void* getRelatedData() const = 0;
};
XERCES_CPP_NAMESPACE_END
#endif
XercesDefs.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
DOMError
DOMError is an interface that describes an error.
Definition DOMError.hpp:40
DOMError::getRelatedException
virtual void * getRelatedException() const =0
The related platform dependent exception if any.
DOMError::getLocation
virtual DOMLocator * getLocation() const =0
Get the location of the error.
DOMError::~DOMError
virtual ~DOMError()
Destructor.
Definition DOMError.hpp:70
DOMError::getType
virtual const XMLCh * getType() const =0
A XMLCh* indicating which related data is expected in relatedData.
DOMError::getSeverity
virtual ErrorSeverity getSeverity() const =0
Get the severity of the error.
DOMError::getRelatedData
virtual void * getRelatedData() const =0
The related DOMError::getType dependent data if any.
DOMError::ErrorSeverity
ErrorSeverity
The severity of the error described by the DOMError.
Definition DOMError.hpp:100
DOMError::DOMError
DOMError()
Definition DOMError.hpp:47
DOMError::getMessage
virtual const XMLCh * getMessage() const =0
Get the message describing the error that occured.
DOMLocator
DOMLocator is an interface that describes a location.
Definition DOMLocator.hpp:42