org.osgi.service.dal

Class DeviceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.osgi.service.dal.DeviceException

All Implemented Interfaces:

Serializable

public class DeviceException
extends IOException

DeviceException is a special IOException, which is thrown to indicate that there is a device operation fail. The error reason can be located with getCode() method. The cause is available with Throwable.getCause().

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMUNICATION_ERROR An exception code indicates that there is an error in the communication.
static int	NO_DATA An exception code indicates that the requested value is currently not available.
static int	NOT_INITIALIZED An exception code indicates that the device is not initialized.
static int	TIMEOUT An exception code indicates that there is expired timeout without any processing.
static int	UNKNOWN An exception code indicates that the error is unknown.

Constructor Summary

Constructors

Constructor and Description
DeviceException() Construct a new device exception with null message.
DeviceException(String message) Constructs a new device exception with the given message.
DeviceException(String message, Throwable cause) Constructs a new device exception with the given message and cause.
DeviceException(String message, Throwable cause, int code) Constructs a new device exception with the given message, cause and code.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns the exception 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 Detail

UNKNOWN

public static final int UNKNOWN

An exception code indicates that the error is unknown.

See Also:

Constant Field Values

COMMUNICATION_ERROR

public static final int COMMUNICATION_ERROR

An exception code indicates that there is an error in the communication.

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

An exception code indicates that there is expired timeout without any processing.

See Also:

Constant Field Values

NOT_INITIALIZED

public static final int NOT_INITIALIZED

An exception code indicates that the device is not initialized. The device status is Device.STATUS_NOT_INITIALIZED or Device.STATUS_PROCESSING.

See Also:

Constant Field Values

NO_DATA

public static final int NO_DATA

An exception code indicates that the requested value is currently not available.

See Also:

Constant Field Values

Constructor Detail

DeviceException

public DeviceException()

Construct a new device exception with null message. The cause is not initialized and the exception code is set to UNKNOWN.

DeviceException

public DeviceException(String message)

Constructs a new device exception with the given message. The cause is not initialized and the exception code is set to UNKNOWN.

Parameters:

message - The exception message.

DeviceException

public DeviceException(String message,
                       Throwable cause)

Constructs a new device exception with the given message and cause. The exception code is set to UNKNOWN.

Parameters:

message - The exception message.

cause - The exception cause.

DeviceException

public DeviceException(String message,
                       Throwable cause,
                       int code)

Constructs a new device exception with the given message, cause and code.

Parameters:

message - The exception message.

cause - The exception cause.

code - The exception code.

Method Detail

getCode

public int getCode()

Returns the exception code. It indicates the reason for this exception. The code can be:

• UNKNOWN
• COMMUNICATION_ERROR
• TIMEOUT
• NOT_INITIALIZED
• NO_DATA
• custom code

Zero and positive values are reserved for this definition and further extensions of the device exception codes. Custom codes can be used only as negative values to prevent potential collisions.

Returns:

An exception code.