org.firebirdsql.gds
Class GDSException
Exception
org.firebirdsql.gds.GDSException
public class GDSException
extends Exception
A GDS-specific exception
protected int | intParam
|
protected GDSException | next - My child
|
protected String | strParam
|
protected int | type
|
protected int | xaErrorCode - The variable
xaErrorCode is used to allow the same
code to be used for transaction control from the XAResource,
LocalTransaction, and Connection.
|
GDSException(String message) - Create a new instance with only a simple message.
|
GDSException(int fbErrorCode) - Create a new instance.
|
GDSException(int type, String strParam) - Create a new instance.
|
GDSException(int type, int intParam) - Create a new instance.
|
GDSException(int type, int fbErrorCode, String strParam) - Construct instance of this class.
|
intParam
protected int intParam
strParam
protected String strParam
xaErrorCode
protected int xaErrorCode
The variable xaErrorCode
is used to allow the same
code to be used for transaction control from the XAResource,
LocalTransaction, and Connection. This code may be added to
the GDSException without obscuring the message: only at the
final level is the GDSException converted to the spec-required
exception.
GDSException
public GDSException(String message)
Create a new instance with only a simple message.
message
- Message for the new exception
GDSException
public GDSException(int fbErrorCode)
Create a new instance.
fbErrorCode
- Firebird error code, one of the constants declared
in GDS
interface
GDSException
public GDSException(int type,
String strParam)
Create a new instance.
type
- type of the exception, should be always
ISCConstants.isc_arg_gds
, otherwise no message will be
displayed.strParam
- value of the string parameter that will substitute
{0}
entry in error message corresponding to the
specified error code.
GDSException
public GDSException(int type,
int intParam)
Create a new instance.
type
- type of the exception, should be always
ISCConstants.isc_arg_gds
, otherwise no message will be
displayed.intParam
- Additional int parameter about the new exception
GDSException
public GDSException(int type,
int fbErrorCode,
String strParam)
Construct instance of this class. This method correctly constructs
chain of exceptions for one string parameter.
type
- type of the exception, should be always
ISCConstants.isc_arg_gds
, otherwise no message will be displayed.fbErrorCode
- Firebird error code, one of the constants declared
in GDS
interface.strParam
- value of the string parameter that will substitute
{0}
entry in error message corresponding to the specified
error code.
createWithXAErrorCode
public static GDSException createWithXAErrorCode(String message,
int xaErrorCode)
Factory method to create a new instance with a given XA
error code.
message
- Message for the new instancexaErrorCode
- The XA
error code
getFbErrorCode
public int getFbErrorCode()
Get the Firebird-specific error code for this exception.
getIntParam
public int getIntParam()
Get the int
parameter for this exception.
getMessage
public String getMessage()
Returns a string representation of this exception.
getNext
public GDSException getNext()
Get the next chained exception.
- The next chained exception
getParam
protected String getParam()
Returns the parameter depending on the type of the
error code.
getXAErrorCode
public int getXAErrorCode()
Get the XaErrorCode value.
isWarning
public boolean isWarning()
Retrieve whether this exception is a warning.
true
if this is a warning,
false
otherwise
setNext
public void setNext(GDSException e)
Set the next exception in the chain.
e
- The next chained exception
setXAErrorCode
public void setXAErrorCode(int xaErrorCode)
Set the XaErrorCode value.
xaErrorCode
- The new XaErrorCode value.
Copyright B) 2001 David Jencks and other authors. All rights reserved.