javax.xml.xquery
Class XQException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by javax.xml.xquery.XQException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
XQTypeException, XQWarning

public class XQException
extends java.lang.Exception

Author:
Michael Stark
See Also:
Serialized Form

Constructor Summary
XQException()
           
XQException(int vendorCode, javax.xml.namespace.QName errorcode, java.lang.String message, int pos, javax.xml.namespace.QName module, javax.xml.namespace.QName function)
          Constructor that takes in a QName and the module and function names in which the error occurred.
XQException(int vendorCode, XQItem item, java.lang.String message, int pos)
          XQException taking in an item and a preformatted optional message string.
XQException(int vendorCode, XQItem item, java.lang.String message, int pos, javax.xml.namespace.QName module, javax.xml.namespace.QName function)
          Constructor that takes in an item and the module and function names in which the error occurred.
XQException(java.lang.String message)
          XQException taking in a preformatted message string.
XQException(java.lang.Throwable throwable)
           
 
Method Summary
 javax.xml.namespace.QName getErrorCode()
          Gets the error code associated with this exception.
 XQItem getErrorItem()
          Returns the generic Item that is associated with this error message.
 int getErrorPosition()
          Gets the error position if possible (default is 0).
 javax.xml.namespace.QName getFunctionName()
          Gets the name of the function, where possible, in which the error occurred.
 javax.xml.namespace.QName getModuleName()
          Gets the name of the module, where possible, in which the error occurred.
 XQException getNextException()
          Returns the next XQException in the chain.
 int getVendorCode()
          Gets a vendor Specific Error code.
 void setNextException(XQException next)
          Adds an XQuery exception to the end of 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XQException

public XQException()

XQException

public XQException(java.lang.String message)
XQException taking in a preformatted message string.


XQException

public XQException(java.lang.Throwable throwable)

XQException

public XQException(int vendorCode,
                   javax.xml.namespace.QName errorcode,
                   java.lang.String message,
                   int pos,
                   javax.xml.namespace.QName module,
                   javax.xml.namespace.QName function)
Constructor that takes in a QName and the module and function names in which the error occurred.


XQException

public XQException(int vendorCode,
                   XQItem item,
                   java.lang.String message,
                   int pos)
XQException taking in an item and a preformatted optional message string.


XQException

public XQException(int vendorCode,
                   XQItem item,
                   java.lang.String message,
                   int pos,
                   javax.xml.namespace.QName module,
                   javax.xml.namespace.QName function)
Constructor that takes in an item and the module and function names in which the error occurred.

Method Detail

getErrorCode

public javax.xml.namespace.QName getErrorCode()
Gets the error code associated with this exception.


getErrorItem

public XQItem getErrorItem()
Returns the generic Item that is associated with this error message.


getErrorPosition

public int getErrorPosition()
Gets the error position if possible (default is 0).


getFunctionName

public javax.xml.namespace.QName getFunctionName()
Gets the name of the function, where possible, in which the error occurred.


getModuleName

public javax.xml.namespace.QName getModuleName()
Gets the name of the module, where possible, in which the error occurred.


getNextException

public XQException getNextException()
Returns the next XQException in the chain.


getVendorCode

public int getVendorCode()
Gets a vendor Specific Error code.


setNextException

public void setNextException(XQException next)
Adds an XQuery exception to the end of the chain of exceptions.