Module is.codion.common.db

Package is.codion.common.db.exception

Class DatabaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

is.codion.common.db.exception.DatabaseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthenticationException, DeleteException, MultipleRecordsFoundException, QueryTimeoutException, RecordNotFoundException, ReferentialIntegrityException, UniqueConstraintException, UpdateException

public class DatabaseException
extends RuntimeException

An exception coming from a database-layer.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DatabaseException(String message)	Constructs a new DatabaseException instance
DatabaseException(String message, String statement)	Constructs a new DatabaseException instance
DatabaseException(SQLException cause)	Constructs a new DatabaseException instance
DatabaseException(SQLException cause, String message)	Constructs a new DatabaseException instance
DatabaseException(SQLException cause, String message, String statement)	Constructs a new DatabaseException instance

Method Summary

Modifier and Type	Method	Description
final int	errorCode()	Returns the underlying error code, note that this is only available when running with a local database connection.
final void	setStackTrace(StackTraceElement[] stackTrace)
final Optional<String>	sqlState()	Returns the underlying sql state, note that this is only available when running with a local database connection.
final Optional<String>	statement()	Returns the sql statement causing this exception, if available, note that this is only available when running with a local database connection.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DatabaseException

public DatabaseException(String message)

Constructs a new DatabaseException instance

Parameters:

message - the exception message

DatabaseException

public DatabaseException(String message,
 String statement)

Constructs a new DatabaseException instance

Parameters:

message - the exception message

statement - the sql statement which caused the exception

DatabaseException

public DatabaseException(SQLException cause)

Constructs a new DatabaseException instance

Parameters:

cause - the root cause, the stack trace is copied and used

DatabaseException

public DatabaseException(SQLException cause,
 String message)

Constructs a new DatabaseException instance

Parameters:

cause - the root cause, the stack trace is copied and used

message - the exception message

DatabaseException

public DatabaseException(SQLException cause,
 String message,
 String statement)

Constructs a new DatabaseException instance

Parameters:

cause - the root cause, the stack trace is copied and used

message - the exception message

statement - the sql statement which caused the exception

Method Details

statement

public final Optional<String> statement()

Returns the sql statement causing this exception, if available, note that this is only available when running with a local database connection.

Returns:

the sql statement which caused the exception, an empty Optional if not avialable

errorCode

public final int errorCode()

Returns the underlying error code, note that this is only available when running with a local database connection.

Returns:

the underlying error code, -1 if not available

sqlState

public final Optional<String> sqlState()

Returns the underlying sql state, note that this is only available when running with a local database connection.

Returns:

the underlying sql state, an empty Optional if not available

setStackTrace

public final void setStackTrace(StackTraceElement[] stackTrace)

Overrides:

setStackTrace in class Throwable