Top Description Fields Constructors Methods
org.osgi.service.zigbee

public Class ZCLException

extends ZigBeeException
Class Inheritance
This class represents root exception for all the code related to ZigBee/ZCL. The provided constants names, but not the values, maps to the ZCL error codes defined in the ZCL specification.
Author
$Id: ff29d19156db4dbd3d6dcd4ea246cc5296bb24f0 $

Field Summary

Modifier and TypeField and Description
public static final int
CALIBRATION_ERROR

ZCL Calibration Error error code.

public static final int
CLUSTER_COMMAND_NOT_SUPPORTED

ZCL Cluster Command Not Supported error code.

public static final int
DUPLICATE_EXISTS

ZCL Duplicate Exists error code.

public static final int
FAILURE

ZCL Failure error code.

public static final int
GENERAL_COMMAND_NOT_SUPPORTED

ZCL General Command Not Supported error code.

public static final int
HARDWARE_FAILURE

HARDWARE_FAILURE - in this case, an additional exception describing the problem can be nested.

public static final int
INSUFFICIENT_SPACE

ZCL Insufficient Space error code.

public static final int
INVALID_DATA_TYPE

ZCL Invalid Data Type error code.

public static final int
INVALID_FIELD

ZCL Invalid Field error code.

public static final int
INVALID_VALUE

ZCL Invalid Value error code.

public static final int
MALFORMED_COMMAND

ZCL Malformed Command error code.

public static final int
MANUF_CLUSTER_COMMAND_NOT_SUPPORTED

ZCL Manuf Cluster Command Not Supported error code.

public static final int
MANUF_GENERAL_COMMAND_NOT_SUPPORTED

ZCL Manuf General Command Not Supported error code.

public static final int
NOT_FOUND

ZCL Not Found error code.

public static final int
READ_ONLY

ZCL Read Only error code.

private static final long
serialVersionUID

Hides org.osgi.service.zigbee.ZigBeeException.serialVersionUID.

public static final int
SOFTWARE_FAILURE

Software Failure error code - in this case, an additional exception describing the problem can be nested.

public static final int
SUCCESS

ZCL Success error code.

public static final int
UNREPORTABLE_TYPE

Unreportable Type error code.

public static final int
UNSUPPORTED_ATTRIBUTE

ZCL Unsupported Attribute error code.

Inherited from org.osgi.service.zigbee.ZigBeeException:
errorCodeOSGI_EXISTING_IDOSGI_MULTIPLE_HOSTSTIMEOUTUNKNOWN_ERRORzigBeeErrorCode

Constructor Summary

AccessConstructor and Description
public
ZCLException(String
exception error description.
errorDesc)

Creates a ZCLException containing only a description, but no error codes.

public
ZCLException(int
One of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface. In this case if the native ZigBee error code is known, it is preferred to use the ZCLException(int, int, String) constructor, passing UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.
errorCode, String
An error description which explain the type of problem.
errorDesc)

Creates a ZCLException containing a specific errorCode.

public
ZCLException(int
One of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface. In this case the zigBeeErrorCode parameter must be the actual status code returned by the ZigBee stack.
errorCode, int
The actual ZCL status code or UNKNOWN_ERROR if this status is unknown.
zigBeeErrorCode, String
An error description which explain the type of problem.
errorDesc)

Creates a ZCLException containing a specific errorCode or zigBeeErrorCode.

Method Summary

Inherited from org.osgi.service.zigbee.ZigBeeException:
getErrorCodegetZigBeeErrorCodehasZigBeeErrorCode

Field Detail

CALIBRATION_ERRORback to summary
public static final int CALIBRATION_ERROR

ZCL Calibration Error error code.

CLUSTER_COMMAND_NOT_SUPPORTEDback to summary
public static final int CLUSTER_COMMAND_NOT_SUPPORTED

ZCL Cluster Command Not Supported error code.

DUPLICATE_EXISTSback to summary
public static final int DUPLICATE_EXISTS

ZCL Duplicate Exists error code.

FAILUREback to summary
public static final int FAILURE

ZCL Failure error code.

GENERAL_COMMAND_NOT_SUPPORTEDback to summary
public static final int GENERAL_COMMAND_NOT_SUPPORTED

ZCL General Command Not Supported error code.

HARDWARE_FAILUREback to summary
public static final int HARDWARE_FAILURE

HARDWARE_FAILURE - in this case, an additional exception describing the problem can be nested.

INSUFFICIENT_SPACEback to summary
public static final int INSUFFICIENT_SPACE

ZCL Insufficient Space error code.

INVALID_DATA_TYPEback to summary
public static final int INVALID_DATA_TYPE

ZCL Invalid Data Type error code.

INVALID_FIELDback to summary
public static final int INVALID_FIELD

ZCL Invalid Field error code.

INVALID_VALUEback to summary
public static final int INVALID_VALUE

ZCL Invalid Value error code.

MALFORMED_COMMANDback to summary
public static final int MALFORMED_COMMAND

ZCL Malformed Command error code.

MANUF_CLUSTER_COMMAND_NOT_SUPPORTEDback to summary
public static final int MANUF_CLUSTER_COMMAND_NOT_SUPPORTED

ZCL Manuf Cluster Command Not Supported error code.

MANUF_GENERAL_COMMAND_NOT_SUPPORTEDback to summary
public static final int MANUF_GENERAL_COMMAND_NOT_SUPPORTED

ZCL Manuf General Command Not Supported error code.

NOT_FOUNDback to summary
public static final int NOT_FOUND

ZCL Not Found error code.

READ_ONLYback to summary
public static final int READ_ONLY

ZCL Read Only error code.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.osgi.service.zigbee.ZigBeeException.serialVersionUID.

SOFTWARE_FAILUREback to summary
public static final int SOFTWARE_FAILURE

Software Failure error code - in this case, an additional exception describing the problem can be nested.

SUCCESSback to summary
public static final int SUCCESS

ZCL Success error code.

UNREPORTABLE_TYPEback to summary
public static final int UNREPORTABLE_TYPE

Unreportable Type error code.

UNSUPPORTED_ATTRIBUTEback to summary
public static final int UNSUPPORTED_ATTRIBUTE

ZCL Unsupported Attribute error code.

Constructor Detail

ZCLExceptionback to summary
public ZCLException(String errorDesc)

Creates a ZCLException containing only a description, but no error codes. If issued on this exception the getErrorCode() and getZigBeeErrorCode() methods return the UNKNOWN_ERROR constant.

Parameters
errorDesc:String

exception error description.

ZCLExceptionback to summary
public ZCLException(int errorCode, String errorDesc)

Creates a ZCLException containing a specific errorCode. Using this constructor with errorCode set to UNKNOWN_ERROR is equivalent to call ZCLException(String).

Parameters
errorCode:int

One of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface. In this case if the native ZigBee error code is known, it is preferred to use the ZCLException(int, int, String) constructor, passing UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.

errorDesc:String

An error description which explain the type of problem.

ZCLExceptionback to summary
public ZCLException(int errorCode, int zigBeeErrorCode, String errorDesc)

Creates a ZCLException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to UNKNOWN_ERROR is equivalent to call ZCLException(String).

Parameters
errorCode:int

One of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface. In this case the zigBeeErrorCode parameter must be the actual status code returned by the ZigBee stack.

zigBeeErrorCode:int

The actual ZCL status code or UNKNOWN_ERROR if this status is unknown.

errorDesc:String

An error description which explain the type of problem.