Package com.lucimber.dbus.codec.encoder

Class ArrayEncoder<E extends DBusType>

java.lang.Object

com.lucimber.dbus.codec.encoder.ArrayEncoder<E>

Type Parameters:

E - The element's data type.

All Implemented Interfaces:

Encoder<DBusArray<E>,ByteBuffer>

public final class ArrayEncoder<E extends DBusType>
extends Object
implements Encoder<DBusArray<E>,ByteBuffer>

An encoder which encodes an array to the D-Bus marshalling format using ByteBuffer.

See Also:

• Encoder
• DBusArray

Constructor Summary

Constructors

Constructor	Description
ArrayEncoder(ByteOrder order, DBusSignature signature)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
EncoderResult<ByteBuffer>	encode(DBusArray<E> array, 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

ArrayEncoder

public ArrayEncoder(ByteOrder order,
 DBusSignature signature)

Constructs a new instance.

Parameters:

order - the byte order of the produced bytes

signature - the array signature (must be an array)

Method Details

encode

public EncoderResult<ByteBuffer> encode(DBusArray<E> array,
 int offset)
                                 throws EncoderException

Description copied from interface: Encoder

Encodes a value into bytes.

Specified by:

encode in interface Encoder<DBusArray<E extends DBusType>,ByteBuffer>

Parameters:

array - 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.