Package org.apache.bookkeeper.client.api

Class BKException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.bookkeeper.client.api.BKException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BKException

@Public
@Unstable
public class BKException
extends Exception

Super class for all errors which occur using BookKeeper client.

Since:

4.6

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BKException.Code	Codes which represent the various exception types.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	code
(package private) static final Function<Throwable,BKException>	HANDLER

Constructor Summary

Constructors

Constructor	Description
BKException(int code)	Create a new exception.
BKException(int code, Throwable cause)	Create a new exception with the cause.

Method Summary

Modifier and Type	Method	Description
static Object	codeLogger(int code)	Returns a lazy error code formatter suitable to pass to log functions.
final int	getCode()	Get the return code for the exception.
static String	getMessage(int code)	Describe an error code.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

Field Details

HANDLER

static final Function<Throwable,BKException> HANDLER

code

protected final int code

Constructor Details

BKException

public BKException(int code)

Create a new exception.

Parameters:

code - the error code

See Also:

• BKException.Code

BKException

public BKException(int code,
 Throwable cause)

Create a new exception with the cause.

Parameters:

code - exception code

cause - the exception cause

Method Details

getCode

public final int getCode()

Get the return code for the exception.

Returns:

the error code

See Also:

• BKException.Code

codeLogger

public static Object codeLogger(int code)

Returns a lazy error code formatter suitable to pass to log functions.

Parameters:

code - the error code value

Returns:

lazy error code log formatter

getMessage

public static String getMessage(int code)

Describe an error code.

Parameters:

code - the error code value

Returns:

the description of the error code