org.eclipse.kura

Class KuraRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.eclipse.kura.KuraRuntimeException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

KuraInvalidMessageException, KuraInvalidMetricTypeException

@ProviderType
public class KuraRuntimeException
extends java.lang.RuntimeException

The KuraRuntimeException class is the superclass of all runtime exceptions in the Kura project. It extends the JDK RuntimeException class by requesting its invokers to provide an error code when building its instances. The code is one value of KuraErrorCode; 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:

KuraErrorCode, Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
KuraErrorCode	getCode() Gets the error code.
java.lang.String	getLocalizedMessage()
java.lang.String	getMessage()

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

Constructor Detail

KuraRuntimeException

public KuraRuntimeException(KuraErrorCode code)

Builds a new KuraRuntimeException instance based on the supplied KuraErrorCode.

Parameters:

code - the error code

KuraRuntimeException

public KuraRuntimeException(KuraErrorCode code,
                            java.lang.Object... arguments)

Builds a new KuraRuntimeException instance based on the supplied KuraErrorCode.

Parameters:

code - the error code

arguments - the arguments

KuraRuntimeException

public KuraRuntimeException(KuraErrorCode code,
                            java.lang.Throwable cause,
                            java.lang.Object... arguments)

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

Parameters:

code - the error code

cause - the cause

arguments - the arguments

Method Detail

getCode

public KuraErrorCode getCode()

Gets the error code.

Returns:

the error code

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable