org.eclipse.kura

Class KuraException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.eclipse.kura.KuraException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

KuraClosedDeviceException, KuraConnectException, KuraGPIODeviceException, KuraNotConnectedException, KuraPartialSuccessException, KuraStoreException, KuraTimeoutException, KuraTooManyInflightMessagesException, KuraUnavailableDeviceException

public class KuraException
extends Exception

The KuraException class is the superclass of all errors and exceptions in the Kura project. It extends the JDK Exception class by requesting its invokers to provide an error code when building its instances. The code is one value of KuraErrorCode enum; the code is used to document the possible error conditions generated by the platform as well as to identify the localized exception messages to be reported. Exceptions messages are stored in the KuraExceptionMessagesBundle Properties Bundle and they are keyed on the exception code.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected KuraErrorCode	m_code

Constructor Summary

Constructors

Constructor and Description
KuraException(KuraErrorCode code) Builds a new EdcException instance based on the supplied EdcErrorCode.
KuraException(KuraErrorCode code, Object... arguments) Builds a new EdcException instance based on the supplied EdcErrorCode.
KuraException(KuraErrorCode code, Throwable cause, Object... arguments) Builds a new EdcException instance based on the supplied EdcErrorCode, an optional Throwable cause, and optional arguments for the associated exception message.

Method Summary

Modifier and Type	Method and Description
KuraErrorCode	getCode()
String	getLocalizedMessage()
String	getMessage()
static KuraException	internalError(String message) Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing only a message.
static KuraException	internalError(Throwable cause) Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing a cause and a message.
static KuraException	internalError(Throwable cause, String message) Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing a cause and a message.

Methods inherited from class java.lang.Throwable

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

m_code

protected KuraErrorCode m_code

Constructor Detail

KuraException

public KuraException(KuraErrorCode code)

Builds a new EdcException instance based on the supplied EdcErrorCode.

Parameters:

code -

KuraException

public KuraException(KuraErrorCode code,
                     Object... arguments)

Builds a new EdcException instance based on the supplied EdcErrorCode.

Parameters:

code -

arguments -

KuraException

public KuraException(KuraErrorCode code,
                     Throwable cause,
                     Object... arguments)

Builds a new EdcException instance based on the supplied EdcErrorCode, an optional Throwable cause, and optional arguments for the associated exception message.

Parameters:

code -

cause -

arguments -

Method Detail

internalError

public static KuraException internalError(Throwable cause,
                                          String message)

Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing a cause and a message.

Parameters:

cause -

message -

Returns:

internalError

public static KuraException internalError(Throwable cause)

Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing a cause and a message.

Parameters:

cause -

Returns:

internalError

public static KuraException internalError(String message)

Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing only a message.

Parameters:

message -

Returns:

getCode

public KuraErrorCode getCode()

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable