public class XQException
extends java.lang.Exception
XQException
provides several kinds of information:
getMessage
.getCause
.getVendorCode
. Refer to the vendor documentation which specific codes can be returned.XQException
objects. If more than one error occurred the exceptions are referenced via this chain.XQException
has a subclass XQQueryException
providing more detailed information about errors that occurred during the processing of a query. An implementation throws a base XQException
when an error occurs in the XQJ implementation. Further, implementations are encouraged to use the more detailed XQQueryException
in case of an error reported by the XQuery engine.XQException
, there is a possibility that there may be additional XQException
objects chained to the original thrown XQException
. To access the additional chained XQException
objects, an application would recursively invoke getNextException
until a null
value is returned.XQException
may have a causal relationship, which consists of one or more Throwable
instances which caused the XQException
to be thrown. The application may recursively call the method getCause
, until a null
value is returned, to navigate the chain of causes.Constructor and Description |
---|
XQException(java.lang.String message)
Constructs an
XQException object with a given message. |
XQException(java.lang.String message, java.lang.String vendorCode)
Constructs an
XQException object with a given message and vendor code. |
Modifier and Type | Method and Description |
---|---|
XQException |
getNextException()
Returns the next
XQException in the chain or null if none. |
java.lang.String |
getVendorCode()
Gets the vendor code associated with this exception or
null if none. |
void |
setNextException(XQException next)
Adds an
XQException to the chain of exceptions. |
public XQException(java.lang.String message)
XQException
object with a given message. An optional chain of additional XQException
objects may be set subsequently using setNextException
.message
- the description of the error. null
indicates that the message string is non existantpublic XQException(java.lang.String message, java.lang.String vendorCode)
XQException
object with a given message and vendor code. An optional chain of additional XQException
objects may be set subsequently using setNextException
.message
- the description of the error. null
indicates that the message string is non existantvendorCode
- a vendor-specific string identifying the error. null
indicates there is no vendor code or it is unknownpublic java.lang.String getVendorCode()
null
if none. A vendor code is a vendor-specific string identifying the failure in a computer-comparable manner. For example, "NOCONNECT" if unable to connect or "DIVBYZERO" if division by zero occurred within the XQuery.null
if none availablepublic XQException getNextException()
XQException
in the chain or null
if none.null
if nonepublic void setNextException(XQException next)
XQException
to the chain of exceptions.next
- the next exception to be added to the chain of exceptions