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

public Class ZigBeeBitmap40

extends Object
implements ZCLSimpleTypeDescription
Class Inheritance
All Implemented Interfaces
org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription, org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription
Imports
java.io.IOException, org.osgi.service.zigbee.ZigBeeDataInput, .ZigBeeDataOutput, .ZigBeeDataTypes, org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription
A singleton class that represents the 'Bitmap 40-bit' data type, as it is defined in the ZigBee Cluster Library specification.
Author
$Id: 51bd128093f5962b1f43917293107fe81a8db9b0 $

Field Summary

Modifier and TypeField and Description
private static final ZigBeeBitmap40
instance

Constructor Summary

AccessConstructor and Description
private
ZigBeeBitmap40()

Method Summary

Modifier and TypeMethod and Description
public Object
deserialize(ZigBeeDataInput
the ZigBeeDataInput from where the value of data type is read from.
is)

Implements org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription.deserialize.

Deserializes a value from the passed ZigBeeDataInput stream.

public short
getId()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getId.

Returns the data type identifier.

public static ZigBeeBitmap40

Returns:

the singleton instance.
getInstance()

Gets a singleton instance of this class.

public Class<?>
getJavaDataType()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getJavaDataType.

Returns the corresponding Java type class.

public String
getName()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getName.

Returns the associated data type name.

public boolean
isAnalog()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.isAnalog.

Checks if the data type is analog.

public void
serialize(ZigBeeDataOutput
a ZigBeeDataOutput stream where to the passed value will be appended. This parameter cannot be null. If null a NullPointerException must be thrown.
os, Object
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.
value)

Implements org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription.serialize.

Serializes a ZigBee data type into a ZigBeeDataOutput stream.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

instanceback to summary
private static final ZigBeeBitmap40 instance

Constructor Detail

ZigBeeBitmap40back to summary
private ZigBeeBitmap40()

Method Detail

deserializeback to summary
public Object deserialize(ZigBeeDataInput is) throws IOException

Implements org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription.deserialize.

Doc from org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription.deserialize.

Deserializes a value from the passed ZigBeeDataInput stream.

Parameters
is:ZigBeeDataInput

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

Returns:Object

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.

Annotations
@Override
Exceptions
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.
getIdback to summary
public short getId()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getId.

Doc from org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getId.

Returns the data type identifier.

Returns:short

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

Annotations
@Override
getInstanceback to summary
public static ZigBeeBitmap40 getInstance()

Gets a singleton instance of this class.

Returns:ZigBeeBitmap40

the singleton instance.

getJavaDataTypeback to summary
public Class<?> getJavaDataType()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getJavaDataType.

Doc from org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getJavaDataType.

Returns the corresponding Java type class.

Returns:Class<?>

the corresponding Java type class.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getName.

Doc from org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.getName.

Returns the associated data type name.

Returns:String

the associated data type name string.

Annotations
@Override
isAnalogback to summary
public boolean isAnalog()

Implements org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.isAnalog.

Doc from org.osgi.service.zigbee.descriptions.ZCLDataTypeDescription.isAnalog.

Checks if the data type is analog.

Returns:boolean

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

Annotations
@Override
serializeback to summary
public void serialize(ZigBeeDataOutput os, Object value) throws IOException

Implements org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription.serialize.

Doc from org.osgi.service.zigbee.descriptions.ZCLSimpleTypeDescription.serialize.

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.

Parameters
os:ZigBeeDataOutput

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

value:Object

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.

Annotations
@Override
Exceptions
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.