Class DatabaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.pyranid.DatabaseException

All Implemented Interfaces:

Serializable

@NotThreadSafe
public class DatabaseException
extends RuntimeException

Thrown when an error occurs when interacting with a Database.

If the cause of this exception is a SQLException, the getErrorCode() and getSqlState() accessors are shorthand for retrieving the corresponding SQLException values.

Since:

1.0.0

Author:

Mark Allen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DatabaseException(String message)	Creates a DatabaseException with the given message.
DatabaseException(String message, Throwable cause)	Creates a DatabaseException which wraps the given cause.
DatabaseException(Throwable cause)	Creates a DatabaseException which wraps the given cause.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getColumn()
Optional<String>	getConstraint()
Optional<String>	getDatatype()
Optional<String>	getDbmsMessage()
Optional<String>	getDetail()
Optional<Integer>	getErrorCode()	Shorthand for SQLException.getErrorCode() if this exception was caused by a SQLException.
Optional<String>	getFile()
Optional<String>	getHint()
Optional<Integer>	getInternalPosition()
Optional<String>	getInternalQuery()
Optional<Integer>	getLine()
Optional<Integer>	getPosition()
Optional<String>	getRoutine()
Optional<String>	getSchema()
Optional<String>	getSeverity()
Optional<String>	getSqlState()	Shorthand for SQLException.getSQLState() if this exception was caused by a SQLException.
Optional<String>	getTable()
Optional<String>	getWhere()
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DatabaseException

public DatabaseException(@Nullable
 String message)

Creates a DatabaseException with the given message.

Parameters:

message - a message describing this exception

DatabaseException

public DatabaseException(@Nullable
 Throwable cause)

Creates a DatabaseException which wraps the given cause.

Parameters:

cause - the cause of this exception

DatabaseException

public DatabaseException(@Nullable
 String message,
 @Nullable
 Throwable cause)

Creates a DatabaseException which wraps the given cause.

Parameters:

message - a message describing this exception

cause - the cause of this exception

Method Details

toString

public String toString()

Overrides:

toString in class Throwable

getErrorCode

@Nonnull
public Optional<Integer> getErrorCode()

Shorthand for SQLException.getErrorCode() if this exception was caused by a SQLException.

Returns:

the value of SQLException.getErrorCode(), or empty if not available

getSqlState

@Nonnull
public Optional<String> getSqlState()

Shorthand for SQLException.getSQLState() if this exception was caused by a SQLException.

Returns:

the value of SQLException.getSQLState(), or empty if not available

getColumn

@Nonnull
public Optional<String> getColumn()

Returns:

the value of the offending column, or empty if not available

Since:

1.0.12

getConstraint

@Nonnull
public Optional<String> getConstraint()

Returns:

the value of the offending constraint, or empty if not available

Since:

1.0.12

getDatatype

@Nonnull
public Optional<String> getDatatype()

Returns:

the value of the offending datatype, or empty if not available

Since:

1.0.12

getDetail

@Nonnull
public Optional<String> getDetail()

Returns:

the value of the offending detail, or empty if not available

Since:

1.0.12

getFile

@Nonnull
public Optional<String> getFile()

Returns:

the value of the offending file, or empty if not available

Since:

1.0.12

getHint

@Nonnull
public Optional<String> getHint()

Returns:

the value of the error hint, or empty if not available

Since:

1.0.12

getInternalPosition

@Nonnull
public Optional<Integer> getInternalPosition()

Returns:

the value of the offending internalPosition, or empty if not available

Since:

1.0.12

getInternalQuery

@Nonnull
public Optional<String> getInternalQuery()

Returns:

the value of the offending internalQuery, or empty if not available

Since:

1.0.12

getLine

@Nonnull
public Optional<Integer> getLine()

Returns:

the value of the offending line, or empty if not available

Since:

1.0.12

getDbmsMessage

@Nonnull
public Optional<String> getDbmsMessage()

Returns:

the value of the error dbmsMessage, or empty if not available

Since:

1.0.12

getPosition

@Nonnull
public Optional<Integer> getPosition()

Returns:

the value of the offending position, or empty if not available

Since:

1.0.12

getRoutine

@Nonnull
public Optional<String> getRoutine()

Returns:

the value of the offending routine, or empty if not available

Since:

1.0.12

getSchema

@Nonnull
public Optional<String> getSchema()

Returns:

the value of the offending schema, or empty if not available

Since:

1.0.12

getSeverity

@Nonnull
public Optional<String> getSeverity()

Returns:

the error severity, or empty if not available

Since:

1.0.12

getTable

@Nonnull
public Optional<String> getTable()

Returns:

the value of the offending table, or empty if not available

Since:

1.0.12

getWhere

@Nonnull
public Optional<String> getWhere()

Returns:

the value of the offending where, or empty if not available

Since:

1.0.12