|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception javax.xml.xquery.XQException
public class XQException
An exception that provides information on XQJ, XQuery or other errors
reported by an XQJ implementation.
Each 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 Summary | |
---|---|
XQException(String message)
Constructs an XQException object with a given message. |
|
XQException(String message,
String vendorCode)
Constructs an XQException object with a given message
and vendor code. |
Method Summary | |
---|---|
XQException |
getNextException()
Returns the next XQException in the chain or
null if none. |
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. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XQException(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(String message, 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 unknownMethod Detail |
---|
public 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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |