Package org.firebirdsql.gds
Class GDSException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.firebirdsql.gds.GDSException
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
GDSServerVersionException
@Deprecated public class GDSException extends java.lang.ExceptionDeprecated.use a normal SQLException or subclass, this class may be removed in Jaybird 7 or laterA GDS-specific exception- Author:
- David Jencks, Roman Rokytskyy
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description GDSException(int fbErrorCode)Deprecated.Create a new instance.GDSException(int type, int intParam)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterGDSException(int type, int fbErrorCode, java.lang.String strParam)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterGDSException(int type, int fbErrorCode, java.lang.String strParam, java.lang.Throwable cause)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterGDSException(int type, java.lang.String strParam)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterGDSException(int fbErrorCode, java.lang.Throwable cause)Deprecated.Create a new instance.GDSException(java.lang.String message)Deprecated.Create a new instance with only a simple message.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static GDSExceptioncreateWithXAErrorCode(java.lang.String message, int xaErrorCode)Deprecated.will be removed in Jaybird 6 without replacementintgetFbErrorCode()Deprecated.will be removed in Jaybird 6 without replacementintgetIntParam()Deprecated.will be removed in Jaybird 6 without replacementjava.lang.StringgetMessage()Deprecated.Returns a string representation of this exception.GDSExceptiongetNext()Deprecated.will be removed in Jaybird 6 without replacementjava.lang.StringgetParam()Deprecated.will be removed in Jaybird 6 without replacementjava.lang.StringgetSQLState()Deprecated.will be removed in Jaybird 6, but replaced bySQLException.getSQLState()intgetXAErrorCode()Deprecated.will be removed in Jaybird 6 without replacementbooleanisWarning()Deprecated.will be removed in Jaybird 6 without replacementvoidsetNext(GDSException e)Deprecated.will be removed in Jaybird 6 without replacementvoidsetXAErrorCode(int xaErrorCode)Deprecated.will be removed in Jaybird 6 without replacement
-
-
-
Constructor Detail
-
GDSException
@Deprecated public GDSException(int type, int intParam)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterCreate a new instance.- Parameters:
type- type of the exception, should be alwaysISCConstants.isc_arg_gds, otherwise no message will be displayed.intParam- Additional int parameter about the new exception
-
GDSException
@Deprecated public GDSException(int type, java.lang.String strParam)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterCreate a new instance.- Parameters:
type- type of the exception, should be alwaysISCConstants.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
@Deprecated public GDSException(int type, int fbErrorCode, java.lang.String strParam)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterConstruct instance of this class. This method correctly constructs chain of exceptions for one string parameter.- Parameters:
type- type of the exception, should be alwaysISCConstants.isc_arg_gds, otherwise no message will be displayed.fbErrorCode- Firebird error code, one of the constants declared inISCConstantsstrParam- value of the string parameter that will substitute{0}entry in error message corresponding to the specified error code.
-
GDSException
@Deprecated public GDSException(int type, int fbErrorCode, java.lang.String strParam, java.lang.Throwable cause)Deprecated.will be removed in Jaybird 6, if you really must use this class, useGDSException(String),GDSException(int), orGDSException(int,Throwable), but keep in mind this class will be removed in Jaybird 7 or laterConstruct instance of this class. This method correctly constructs chain of exceptions for one string parameter.- Parameters:
type- type of the exception, should be alwaysISCConstants.isc_arg_gds, otherwise no message will be displayed.fbErrorCode- Firebird error code, one of the constants declared inISCConstantsstrParam- value of the string parameter that will substitute{0}entry in error message corresponding to the specified error code.cause- Cause of this exception
-
GDSException
public GDSException(int fbErrorCode)
Deprecated.Create a new instance.- Parameters:
fbErrorCode- Firebird error code, one of the constants declared inISCConstants
-
GDSException
public GDSException(int fbErrorCode, java.lang.Throwable cause)Deprecated.Create a new instance.- Parameters:
fbErrorCode- Firebird error code, one of the constants declared inISCConstantscause- Cause of this exception
-
GDSException
public GDSException(java.lang.String message)
Deprecated.Create a new instance with only a simple message.- Parameters:
message- Message for the new exception
-
-
Method Detail
-
createWithXAErrorCode
@Deprecated public static GDSException createWithXAErrorCode(java.lang.String message, int xaErrorCode)
Deprecated.will be removed in Jaybird 6 without replacementFactory method to create a new instance with a givenXAerror code.- Parameters:
message- Message for the new instancexaErrorCode- TheXAerror code
-
getFbErrorCode
@Deprecated public int getFbErrorCode()
Deprecated.will be removed in Jaybird 6 without replacementGet the Firebird-specific error code for this exception.- Returns:
- The Firebird error code
-
getSQLState
@Deprecated public java.lang.String getSQLState()
Deprecated.will be removed in Jaybird 6, but replaced bySQLException.getSQLState()Get the SQL state of this exception.- Returns:
- the SQL state of this exception or
nullif this object does not represent an error.
-
getIntParam
@Deprecated public int getIntParam()
Deprecated.will be removed in Jaybird 6 without replacementGet theintparameter for this exception.- Returns:
- The
intparameter
-
getXAErrorCode
@Deprecated public int getXAErrorCode()
Deprecated.will be removed in Jaybird 6 without replacementGet the XaErrorCode value.- Returns:
- the XaErrorCode value.
-
setXAErrorCode
@Deprecated public void setXAErrorCode(int xaErrorCode)
Deprecated.will be removed in Jaybird 6 without replacementSet the XaErrorCode value.- Parameters:
xaErrorCode- The new XaErrorCode value.
-
setNext
@Deprecated public void setNext(GDSException e)
Deprecated.will be removed in Jaybird 6 without replacementSet the next exception in the chain.- Parameters:
e- The next chained exception
-
getNext
@Deprecated public GDSException getNext()
Deprecated.will be removed in Jaybird 6 without replacementGet the next chained exception.- Returns:
- The next chained exception
-
isWarning
@Deprecated public boolean isWarning()
Deprecated.will be removed in Jaybird 6 without replacementRetrieve whether this exception is a warning.- Returns:
trueif this is a warning,falseotherwise
-
getMessage
public java.lang.String getMessage()
Deprecated.Returns a string representation of this exception.- Overrides:
getMessagein classjava.lang.Throwable
-
getParam
@Deprecated public java.lang.String getParam()
Deprecated.will be removed in Jaybird 6 without replacementReturns the parameter depending on the type of the error code.
-
-