Package com.lucimber.dbus.message

Class OutboundError

java.lang.Object

com.lucimber.dbus.message.OutboundError

All Implemented Interfaces:

Message, OutboundMessage, OutboundReply

public final class OutboundError
extends Object
implements OutboundReply

An outbound error message.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutboundError.Builder

Constructor Summary

Constructors

Constructor	Description
OutboundError(DBusUInt32 serial, DBusUInt32 replySerial, DBusString errorName, DBusString dst, DBusSignature signature, List<? extends DBusType> payload)	Constructs a new instance with all parameter.

Method Summary

Modifier and Type	Method	Description
Optional<DBusString>	getDestination()	Gets the unique name of the destination.
DBusString	getErrorName()	Returns the name of this error.
List<DBusType>	getPayload()	Gets the payload of this D-Bus message.
DBusUInt32	getReplySerial()	Gets the serial number of the message this message is a reply to.
DBusUInt32	getSerial()	Gets the serial number of this D-Bus message.
Optional<DBusSignature>	getSignature()	Gets the signature of the payload.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lucimber.dbus.message.Message

getPayload, getSerial, getSignature

Methods inherited from interface com.lucimber.dbus.message.OutboundReply

getReplySerial

Constructor Details

OutboundError

public OutboundError(DBusUInt32 serial,
 DBusUInt32 replySerial,
 DBusString errorName,
 DBusString dst,
 DBusSignature signature,
 List<? extends DBusType> payload)

Constructs a new instance with all parameter.

Parameters:

serial - the serial number

replySerial - the reply serial number

errorName - the name of this error

dst - optional; the destination of this error

signature - optional; the signature of the message body

payload - optional; the message body

Method Details

getDestination

public Optional<DBusString> getDestination()

Description copied from interface: OutboundMessage

Gets the unique name of the destination.

Specified by:

getDestination in interface OutboundMessage

Returns:

an Optional of DBusString

getErrorName

public DBusString getErrorName()

Returns the name of this error.

Returns:

a DBusString

toString

public String toString()

getReplySerial

public DBusUInt32 getReplySerial()

Gets the serial number of the message this message is a reply to.

Returns:

The serial number as an DBusUInt32.

getSerial

public DBusUInt32 getSerial()

Description copied from interface: Message

Gets the serial number of this D-Bus message.

Specified by:

getSerial in interface Message

Returns:

an DBusUInt32

getPayload

public List<DBusType> getPayload()

Description copied from interface: Message

Gets the payload of this D-Bus message.

Specified by:

getPayload in interface Message

Returns:

a List of DBusTypes.

getSignature

public Optional<DBusSignature> getSignature()

Description copied from interface: Message

Gets the signature of the payload.

Specified by:

getSignature in interface Message

Returns:

an Optional of DBusSignature