Package com.lucimber.dbus.codec.encoder

Class StructEncoder

java.lang.Object

com.lucimber.dbus.codec.encoder.StructEncoder

All Implemented Interfaces:

Encoder<DBusStruct,ByteBuffer>

public final class StructEncoder
extends Object
implements Encoder<DBusStruct,ByteBuffer>

An encoder which encodes a struct to the D-Bus marshalling format using ByteBuffer.

See Also:

• Encoder
• DBusStruct

Constructor Summary

Constructors

Constructor	Description
StructEncoder(ByteOrder order, DBusSignature signature)	Constructs a new instance with mandatory parameter.

Method Summary

Modifier and Type	Method	Description
EncoderResult<ByteBuffer>	encode(DBusStruct struct, int offset)	Encodes a value into bytes.

Methods inherited from class java.lang.Object

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

Constructor Details

StructEncoder

public StructEncoder(ByteOrder order,
 DBusSignature signature)

Constructs a new instance with mandatory parameter.

Parameters:

order - the byte order of the produced bytes

signature - the signature of the struct being encoded

Method Details

encode

public EncoderResult<ByteBuffer> encode(DBusStruct struct,
 int offset)
                                 throws EncoderException

Description copied from interface: Encoder

Encodes a value into bytes.

Specified by:

encode in interface Encoder<DBusStruct,ByteBuffer>

Parameters:

struct - The data type that needs to be encoded.

offset - The byte count of already encoded bytes, which is necessary for alignment padding.

Returns:

An EncoderResult containing the marshalled representation of the value.

Throws:

EncoderException - If the value could not have been encoded.