Package org.osgi.service.zigbee.types

Class ZigBeeClusterID

java.lang.Object

org.osgi.service.zigbee.types.ZigBeeClusterID

All Implemented Interfaces:

ZCLDataTypeDescription, ZCLSimpleTypeDescription

public class ZigBeeClusterID
extends Object
implements ZCLSimpleTypeDescription

A singleton class that represents the 'Cluster ID' data type, as it is defined in the ZigBee Cluster Library specification.

Method Summary

Modifier and Type	Method	Description
Object	deserialize(ZigBeeDataInput is)	Deserializes a value from the passed ZigBeeDataInput stream.
short	getId()	Returns the data type identifier.
static ZigBeeClusterID	getInstance()	Gets a singleton instance of this class.
Class<?>	getJavaDataType()	Returns the corresponding Java type class.
String	getName()	Returns the associated data type name.
boolean	isAnalog()	Checks if the data type is analog.
void	serialize(ZigBeeDataOutput os, Object value)	Serializes a ZigBee data type into a ZigBeeDataOutput stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static ZigBeeClusterID getInstance()

Gets a singleton instance of this class.

Returns:

the singleton instance.

getName

public String getName()

Description copied from interface: ZCLDataTypeDescription

Returns the associated data type name.

Specified by:

getName in interface ZCLDataTypeDescription

Returns:

the associated data type name string.

isAnalog

public boolean isAnalog()

Description copied from interface: ZCLDataTypeDescription

Checks if the data type is analog.

Specified by:

isAnalog in interface ZCLDataTypeDescription

Returns:

true, if the data type is Analog, otherwise is Discrete.

getJavaDataType

public Class<?> getJavaDataType()

Description copied from interface: ZCLDataTypeDescription

Returns the corresponding Java type class.

Specified by:

getJavaDataType in interface ZCLDataTypeDescription

Returns:

the corresponding Java type class.

getId

public short getId()

Description copied from interface: ZCLDataTypeDescription

Returns the data type identifier.

Specified by:

getId in interface ZCLDataTypeDescription

Returns:

the data type identifier. The data types identifiers supported by this specification are defined in the ZigBeeDataTypes interface.

serialize

public void serialize(ZigBeeDataOutput os,
 Object value)
               throws IOException

Description copied from interface: ZCLSimpleTypeDescription

Serializes a ZigBee data type into a ZigBeeDataOutput stream. An implementation of this method must throw an IllegalArgumentException if the passed value does not belong to the expected class or its value exceeds the possible values allowed (in terms of range or length).

An implementation of this method must interpret (where it makes sense) a null value as the request to serialize the so called Invalid Value.

Specified by:

serialize in interface ZCLSimpleTypeDescription

Parameters:

os - a ZigBeeDataOutput stream where to the passed value will be appended. This parameter cannot be null. If null a NullPointerException must be thrown.

value - The value that have to be serialized on the output stream. If null is passed this method outputs on the stream the ZigBee invalid value related the specific data type. If the data type do not allow any invalid value and the passed value is null an IllegalArgumentException is thrown.

Throws:

IOException - If an I/O error occurs while writing on the ZigBeeDataOutput. The EOFException may be thrown if there is no more space on the data output for serializing the passed value.

deserialize

public Object deserialize(ZigBeeDataInput is)
                   throws IOException

Description copied from interface: ZCLSimpleTypeDescription

Deserializes a value from the passed ZigBeeDataInput stream.

Specified by:

deserialize in interface ZCLSimpleTypeDescription

Parameters:

is - the ZigBeeDataInput from where the value of data type is read from.

Returns:

An object that represents the deserialized value of data. Returns null if the read value represents the Invalid Value for the specific ZigBee data type.

Throws:

IOException - If an I/O error occurs while reading the ZigBeeDataInput. An EOFException is thrown if the data input stream end is reached while deserializing the data type.