Package com.lucimber.dbus.message

Class InboundError

java.lang.Object

com.lucimber.dbus.message.InboundError

All Implemented Interfaces:

InboundMessage, InboundReply, Message

public final class InboundError
extends Object
implements InboundReply

An inbound error message.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InboundError.Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
DBusString	getSender()	Gets the sender of this inbound message.
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.InboundReply

getReplySerial

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

getPayload, getSerial, getSignature

Constructor Details

InboundError

public InboundError(DBusUInt32 serial,
 DBusUInt32 replySerial,
 DBusString sender,
 DBusString errorName)

Constructs a new instance with mandatory parameter.

Parameters:

serial - the serial number

replySerial - the reply serial number

sender - the origin of this error message

errorName - the name of the error

InboundError

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

Constructs a new instance with all parameter.

Parameters:

serial - the serial number

replySerial - the reply serial number

sender - the origin of this error message

errorName - the name of the error

signature - optional; the signature of the message body

payload - optional; the message body

Method Details

getSender

public DBusString getSender()

Description copied from interface: InboundMessage

Gets the sender of this inbound message.

Specified by:

getSender in interface InboundMessage

Returns:

a 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