com.marklogic.xdbc
Class XDBCXQueryRuntimeException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              com.marklogic.xdbc.XDBCRuntimeException
                  com.marklogic.xdbc.XDBCXQueryRuntimeException

All Implemented Interfaces:

Serializable

public class XDBCXQueryRuntimeException

extends XDBCRuntimeException

An XDBCXQueryRuntimeException provides information on an XQuery runtime exception that occurs during XDBC processing.

The information in the XDBCRuntimeException includes:

• a string describing the error, available via the method getMessage()
• a format string and data for a detailed error message
• a link to the next exception
• a Throwable cause object which contains a Java stack trace
• an XML database query evaluator stack trace

See Also:

Serialized Form

Constructor Summary

XDBCXQueryRuntimeException(String code, String message, String formatString, boolean retryable, String[] data, XDBCXQueryException.Frame[] stack)
Constructs an XDBCXQueryRuntimeException

XDBCXQueryRuntimeException(String code, String message, String formatString, boolean retryable, String expression, String[] data, XDBCXQueryException.Frame[] stack)
Constructs an XDBCXQueryRuntimeException

XDBCXQueryRuntimeException(XDBCXQueryException exception)
Constructs an XDBCXQueryRuntimeException from and XDBCXQueryException

Method Summary

String	getCode() Return the symbolic exception code
String[]	getData() Return the exception data
String	getExpression() Return the expression which caused the exception.
String	getFormatString() Return the exception format string
boolean	getRetryable() Return whether retrying the operation may suceed
XDBCXQueryException.Frame[]	getStack() Return the XQuery Evaluator stack trace for this XDBCRuntimeException.
String	toString() Returns a string representation of the object.

Methods inherited from class com.marklogic.xdbc.XDBCRuntimeException

getNextException, setNextException

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XDBCXQueryRuntimeException

public XDBCXQueryRuntimeException(String code,
                                  String message,
                                  String formatString,
                                  boolean retryable,
                                  String[] data,
                                  XDBCXQueryException.Frame[] stack)

Constructs an XDBCXQueryRuntimeException

Parameters:

code - the symbolic exception code

message - the exception message

formatString - the exception format string

retryable - retrying the operation may succeed

data - the exception data

stack - the xquery evaluator stack trace

XDBCXQueryRuntimeException

public XDBCXQueryRuntimeException(String code,
                                  String message,
                                  String formatString,
                                  boolean retryable,
                                  String expression,
                                  String[] data,
                                  XDBCXQueryException.Frame[] stack)

Constructs an XDBCXQueryRuntimeException

Parameters:

code - the symbolic exception code

message - the exception message

formatString - the exception format string

retryable - retrying the operation may succeed

expression - the expression which caused the exception

data - the exception data

stack - the xquery evaluator stack trace

XDBCXQueryRuntimeException

public XDBCXQueryRuntimeException(XDBCXQueryException exception)

Constructs an XDBCXQueryRuntimeException from and XDBCXQueryException

Parameters:

exception - the XDBCXQueryException

Method Detail

getCode

public String getCode()

Return the symbolic exception code

getFormatString

public String getFormatString()

Return the exception format string

getRetryable

public boolean getRetryable()

Return whether retrying the operation may suceed

getExpression

public String getExpression()

Return the expression which caused the exception.

getData

public String[] getData()

Return the exception data

getStack

public XDBCXQueryException.Frame[] getStack()

Return the XQuery Evaluator stack trace for this XDBCRuntimeException.

Note that this is the server-side stack trace from evaluating the XQuery, NOT the client-side Java runtime stack trace.

Returns:

an array of XDBCXQueryException.Frame objects

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class XDBCRuntimeException

Returns:

a string representation of the object.