SaxonApiException Class Reference

SaxonApiException. More...

#include <SaxonApiException.h>

Inheritance diagram for SaxonApiException:

Public Member Functions
	SaxonApiException (bool staticError=false)
	Default constructor.
	SaxonApiException (const char *err)
	A constructor.
	SaxonApiException (const SaxonApiException &ex)
	SaxonApiException copy constructor.
virtual const char *	what ()
	Returns a pointer to the (constant) error description.
	SaxonApiException (const char *message, const char *errorCode, const char *systemId, int linenumber)
	A constructor.
virtual	~SaxonApiException () throw ()
	A destructor.
const char *	getErrorCode ()
	Get the error code associated with the current exception, if it exists.
int	getLineNumber ()
	Get the line number associated with the exception, if known.
const char *	getMessage ()
	Returns the detail message string as a char array of the throwable, if there is one.
const char *	getMessageWithErrorCode ()
	Returns the detail message string as a char array of the throwable, if there is one.
const char *	getCombinedStaticErrorMessages ()
	Returns static error messages resulting from compile errors as a char array of the throwable, if there are any.
int	staticErrorCount ()
	Returns the number of static errors encountered.
const char *	getSystemId ()
	Get the URI of the module associated with the exception, if known.

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

(

bool

staticError = false

)

Default constructor.

Creates a SaxonApiException

SaxonApiException() [2/4]

SaxonApiException::SaxonApiException

(

const char *

err

)

A constructor.

Create a SaxonApiException

Parameters

err	- The detail message string of this throwable.

SaxonApiException() [3/4]

SaxonApiException::SaxonApiException

(

const SaxonApiException &

ex

)

SaxonApiException copy constructor.

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

Member Function Documentation

getCombinedStaticErrorMessages()

const char * SaxonApiException::getCombinedStaticErrorMessages

(

)

Returns static error messages resulting from compile errors as a char array of the throwable, if there are any.

The caller does not need to deallocate memory.

Returns

the detail message string of this Throwable instance with the error code as prefix if there is an error code associated with the exception. Memory deallocation is handled internally.

getErrorCode()

const char * SaxonApiException::getErrorCode

(

)

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

The caller does not need to deallocate memory.

Returns

the associated error code, or null if no error code is available. Memory deallocation is handled internally.

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.

The caller does not need to deallocate memory.

Returns

the detail message string of this Throwable instance (which may be null). Memory deallocation is handled internally.

getMessageWithErrorCode()

const char * SaxonApiException::getMessageWithErrorCode

(

)

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

The caller does not need to deallocate memory.

Returns

the detail message string of this Throwable instance with the error code as prefix if there is an error code associated with the exception. Memory deallocation is handled internally.

getSystemId()

const char * SaxonApiException::getSystemId

(

)

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

Memory deallocation is handled internally.

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 possession of the Exception object. Callers must not attempt to free the memory.

---

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

• /Volumes/Saxonica/src/saxonica/saxondev/libsaxonc/src/include/saxonc/SaxonApiException.h
• /Volumes/Saxonica/src/saxonica/saxondev/libsaxonc/src/lib/SaxonApiException.cpp