com.sequoiadb.exception

Class BaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.sequoiadb.exception.BaseException

All Implemented Interfaces:

Serializable

public class BaseException
extends RuntimeException

Base exception of SequoiaDB.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseException(int errCode)
BaseException(int errCode, String detail)
BaseException(int errCode, String detail, BSONObject errorObject)
BaseException(SDBError error)
BaseException(SDBError error, String detail)
BaseException(SDBError error, String detail, Throwable e)
BaseException(SDBError error, Throwable e)

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Get the error code.
BSONObject	getErrorObject() Get the error object.
String	getErrorType() Get the error type.
String	getMessage() Get the error message.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseException

public BaseException(int errCode)

Parameters:

errCode - The error code return by engine.

Since:

2.8

BaseException

public BaseException(int errCode,
                     String detail)

Parameters:

errCode - The error code return by engine.

detail - The error detail.

Since:

2.8

BaseException

public BaseException(int errCode,
                     String detail,
                     BSONObject errorObject)

Parameters:

errCode - The error code return by engine.

detail - The error detail.

errorObject - The error object return from engine.

Since:

3.0.1

BaseException

public BaseException(SDBError error)

Parameters:

error - The enumeration object of sequoiadb error.

Since:

2.8

BaseException

public BaseException(SDBError error,
                     String detail)

Parameters:

error - The enumeration object of sequoiadb error.

detail - The error detail.

Since:

2.8

BaseException

public BaseException(SDBError error,
                     String detail,
                     Throwable e)

Parameters:

error - The enumeration object of sequoiadb error.

detail - The error detail.

e - The exception used to build exception chain.

Since:

2.8

BaseException

public BaseException(SDBError error,
                     Throwable e)

Parameters:

error - The enumeration object of sequoiadb error.

e - The exception used to build exception chain.

Since:

2.8

Method Detail

getErrorCode

public int getErrorCode()

Get the error code.

Returns:

The error code.

getErrorObject

public BSONObject getErrorObject()

Get the error object. When database try to tell the user what error happen in engine, it will merge all the error information, and return it by an BSONObject. When no detail, error object is null.

Returns:

The error object got from engine or null for no error object got from engine. If there has an error, it contains the follow fields:

• errno: the error number.
• description: the description of the errno.
• detail: the error detail.
• ErrNodes: describes which data nodes have errors, and detailed information about the error (this field is an expand field, which is only returned when an error occurs on the data node)

getErrorType

public String getErrorType()

Get the error type.

Returns:

The error type.

getMessage

public String getMessage()

Get the error message.

Overrides:

getMessage in class Throwable

Returns:

The error message.