public interface ZCLSimpleTypeDescription extends ZCLDataTypeDescription
The interface extends the ZCLDataTypeDescription
by providing
serialize and deserialize methods to marshal and unmarshal the data into the
ZigBeeDataInput
and from ZigBeeDataOutput
streams.
Related documentation: [1] ZigBee Cluster Library specification, Document 075123r04ZB, May 29, 2012.
Modifier and Type | Method and Description |
---|---|
Object |
deserialize(ZigBeeDataInput is)
Deserializes a value from the passed
ZigBeeDataInput stream. |
void |
serialize(ZigBeeDataOutput os,
Object value)
Serializes a ZigBee data type into a
ZigBeeDataOutput stream. |
getId, getJavaDataType, getName, isAnalog
void serialize(ZigBeeDataOutput os, Object value) throws IOException
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.
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.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.NullPointerException
- If ZigBeeDataOutput
parameter is
null
.IllegalArgumentException
- If the passed value parameter does not
belong to the expected class or its value exceeds the possible
values allowed (range or length).Object deserialize(ZigBeeDataInput is) throws IOException
ZigBeeDataInput
stream.is
- the ZigBeeDataInput
from where the value of data type
is read from.null
if the read value represents the Invalid
Value for the specific ZigBee data type.NullPointerException
- If ZigBeeDataInput
parameter is
null
.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.Copyright © Contributors to the Eclipse Foundation Licensed under the Eclipse Foundation Specification License – v1.0