Package com.lucimber.dbus.codec.decoder

Class StructDecoder

java.lang.Object

com.lucimber.dbus.codec.decoder.StructDecoder

All Implemented Interfaces:

Decoder<ByteBuffer,DBusStruct>

public final class StructDecoder
extends Object
implements Decoder<ByteBuffer,DBusStruct>

A decoder which unmarshals a struct from the byte stream format used by D-Bus.

See Also:

• Decoder
• DBusStruct

Constructor Summary

Constructors

Constructor	Description
StructDecoder(DBusSignature signature)	Creates a new instance with mandatory parameters.

Method Summary

Modifier and Type	Method	Description
DecoderResult<DBusStruct>	decode(ByteBuffer buffer, int offset)	Decodes a specific type from a buffer.

Methods inherited from class java.lang.Object

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

Constructor Details

StructDecoder

public StructDecoder(DBusSignature signature)

Creates a new instance with mandatory parameters.

Parameters:

signature - a DBusSignature; must describe a struct

Method Details

decode

public DecoderResult<DBusStruct> decode(ByteBuffer buffer,
 int offset)
                                 throws DecoderException

Description copied from interface: Decoder

Decodes a specific type from a buffer.

Specified by:

decode in interface Decoder<ByteBuffer,DBusStruct>

Parameters:

buffer - The buffer that contains the marshalled type.

offset - The number of bytes of a message, that have already been decoded.

Returns:

The result of the decoding procedure.

Throws:

DecoderException - If the value could not be decoded successfully.