SaxonC  11.3
Saxon Processor library for C/C++, PHP and Python
Public Member Functions | List of all members
SaxonApiException Class Reference

#include <SaxonApiException.h>

Inheritance diagram for SaxonApiException:

Public Member Functions

 SaxonApiException ()
 
 SaxonApiException (const char *message)
 
 SaxonApiException (const SaxonApiException &ex)
 
virtual const char * what ()
 
 SaxonApiException (const char *message, const char *errorCode, const char *systemId, int linenumber)
 
virtual ~SaxonApiException () throw ()
 
const char * getErrorCode ()
 
int getLineNumber ()
 
const char * getMessage ()
 
std::string getMessageStr ()
 
const char * getSystemId ()
 

Detailed Description

SaxonApiException. An exception thrown by the Saxon s9api API (Java). This is always a C++ wrapper for some other underlying exception in Java

Constructor & Destructor Documentation

◆ SaxonApiException() [1/4]

SaxonApiException::SaxonApiException ( )

A default Constructor. Create a SaxonApiException

◆ SaxonApiException() [2/4]

SaxonApiException::SaxonApiException ( const char *  message)

A constructor. Create a SaxonApiException

Parameters
message- The detail message string of this throwable.

◆ SaxonApiException() [3/4]

SaxonApiException::SaxonApiException ( const SaxonApiException ex)

A Copy constructor. Create a SaxonApiException

Parameters
ex- The exception object to copy

◆ SaxonApiException() [4/4]

SaxonApiException::SaxonApiException ( const char *  message,
const char *  errorCode,
const char *  systemId,
int  linenumber 
)

A constructor. Create a SaxonApiException

Parameters
message- The detail message string of this throwable.
errorCode- The error code of the underlying exception thrown, if known
systemId- Get the URI of the module associated with the exception, if known.
lineNumber- The line number in the stylesheet related to cause of the exception

◆ ~SaxonApiException()

virtual SaxonApiException::~SaxonApiException ( )
throw (
)
inlinevirtual

A destructor.

Member Function Documentation

◆ getErrorCode()

const char * SaxonApiException::getErrorCode ( )

Get the error code associated with the exception, if it exists

Returns
the associated error code, or null if no error code is available

Get the error code associated with the ith exception in the vector, if there is one

Parameters
i- ith exception in the vector
Returns
the associated error code, or nullptr if no error code is available

◆ getLineNumber()

int SaxonApiException::getLineNumber ( )

Get the line number associated with the exception, if known.

Returns
the line number (typically of a line in a stylesheet, query, or schema, but in the case of validation errors it may be a line in a source document); or -1 if not known

◆ getMessage()

const char * SaxonApiException::getMessage ( )

Returns the detail message string as a char array of the throwable, if there is one

Returns
the detail message string of this Throwable instance (which may be null).

◆ getMessageStr()

std::string SaxonApiException::getMessageStr ( )

Returns the detail message string of the throwable, if there is one

Returns
the detail message string of this Throwable instance (which may be null).

◆ getSystemId()

const char * SaxonApiException::getSystemId ( )

Get the URI of the module associated with the exception, if known.

◆ what()

const char * SaxonApiException::what ( )
virtual

Returns a pointer to the (constant) error description.

Returns
A pointer to a const char*. The underlying memory is in posession of the Exception object. Callers must not attempt to free the memory.

The documentation for this class was generated from the following files: