org.osgi.service.zigbee

Class ZigBeeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgi.service.zigbee.ZigBeeException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

APSException, ZCLException, ZDPException

public class ZigBeeException
extends RuntimeException

This class represents root exception for all the code related to ZigBee. The provided constants names, but not the values.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	errorCode The error code associated to this exception.
static int	OSGI_EXISTING_ID The error code used when another endpoint exists with the same ID.
static int	OSGI_MULTIPLE_HOSTS The error code used when several hosts exist for this PAN ID target or HOST_PID target.
static int	TIMEOUT The error code used when the timeout of ZigBee asynchronous exchange is reached.
static int	UNKNOWN_ERROR This error code is used if the ZigBee error returned is not covered by this API specification.
protected int	zigBeeErrorCode The actual error code returned by the ZigBee node.

Constructor Summary

Constructors

Constructor and Description
ZigBeeException(int errorCode, int zigBeeErrorCode, String errorDesc) Creates a ZigBeeException containing a specific errorCode or zigBeeErrorCode.
ZigBeeException(int errorCode, String errorDesc) Creates a ZigBeeException containing a specific errorCode.
ZigBeeException(String errorDesc) Creates a ZigBeeException containing only a description, but no error codes.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns the error code.
int	getZigBeeErrorCode() Returns the potential ZigBee error code.
boolean	hasZigBeeErrorCode() Checks if this exception has a ZigBee 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 Detail

OSGI_EXISTING_ID

public static final int OSGI_EXISTING_ID

The error code used when another endpoint exists with the same ID.

See Also:

Constant Field Values

OSGI_MULTIPLE_HOSTS

public static final int OSGI_MULTIPLE_HOSTS

The error code used when several hosts exist for this PAN ID target or HOST_PID target.

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

The error code used when the timeout of ZigBee asynchronous exchange is reached.

See Also:

Constant Field Values

UNKNOWN_ERROR

public static final int UNKNOWN_ERROR

This error code is used if the ZigBee error returned is not covered by this API specification.

See Also:

Constant Field Values

errorCode

protected final int errorCode

The error code associated to this exception.

See Also:

getErrorCode()

zigBeeErrorCode

protected final int zigBeeErrorCode

The actual error code returned by the ZigBee node.

See Also:

getZigBeeErrorCode()

Constructor Detail

ZigBeeException

public ZigBeeException(String errorDesc)

Creates a ZigBeeException 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 - exception error description.

ZigBeeException

public ZigBeeException(int errorCode,
                       String errorDesc)

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

Parameters:

errorCode - One of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface.

errorDesc - An error description which explain the type of problem.

ZigBeeException

public ZigBeeException(int errorCode,
                       int zigBeeErrorCode,
                       String errorDesc)

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

Parameters:

errorCode - One of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface.

zigBeeErrorCode - The actual status code or UNKNOWN_ERROR if this status is unknown.

errorDesc - An error description which explain the type of problem.

Method Detail

getZigBeeErrorCode

public int getZigBeeErrorCode()

Returns the potential ZigBee error code.

Returns:

One of the error codes defined above. If the returned error code is UNKNOWN_ERROR and the hasZigBeeErrorCode() returns true then the getZigBeeErrorCode() provides the actual ZigBee error code returned by the device.

getErrorCode

public int getErrorCode()

Returns the error code.

Returns:

the error code.

hasZigBeeErrorCode

public boolean hasZigBeeErrorCode()

Checks if this exception has a ZigBee error code.

Returns:

true if the ZigBeeException convey also the actual error code returned by the ZigBee stack.