Package org.sim0mq.message

Class Sim0MQReply.Builder<B extends Sim0MQMessage.Builder<B>>

java.lang.Object

org.sim0mq.message.Sim0MQMessage.Builder<B>

org.sim0mq.message.Sim0MQReply.Builder<B>

Type Parameters:

B - the actual inherited builder for the return types.

Direct Known Subclasses:

HB2AliveMessage.Builder, MC1StatusMessage.Builder, MC2AckNakMessage.Builder

Enclosing class:

Sim0MQReply

public abstract static class Sim0MQReply.Builder<B extends Sim0MQMessage.Builder<B>>
extends Sim0MQMessage.Builder<B>

Builder for the Sim0MQReply. Can string setters together, and call build() at the end to build the actual message.

Copyright (c) 2016-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Apr 22, 2017

Author:

Alexander Verbraeck

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	replyToId	The unique message id (Frame 5) of the sender for which this is the reply.

Fields inherited from class org.sim0mq.message.Sim0MQMessage.Builder

federationId, messageId, messageTypeId, receiverId, senderId

Constructor Summary

Constructors

Constructor	Description
Builder()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
abstract Sim0MQReply	build()	Build the object.
final B	setReplyTo(Sim0MQMessage message)
final B	setReplyToId(Object newReplyToId)

Methods inherited from class org.sim0mq.message.Sim0MQMessage.Builder

setMessageId, setMessageTypeId, setReceiverId, setSenderId, setSimulationRunId

Methods inherited from class java.lang.Object

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

Field Details

replyToId

protected Object replyToId

The unique message id (Frame 5) of the sender for which this is the reply.

Constructor Details

Builder

public Builder()

Empty constructor.

Method Details

setReplyToId

public final B setReplyToId(Object newReplyToId)

Parameters:

newReplyToId - set replyToId

Returns:

the original object for chaining

setReplyTo

public final B setReplyTo(Sim0MQMessage message)

Parameters:

message - set replyToId and receiver based on the message to which this is a reply

Returns:

the original object for chaining

build

public abstract Sim0MQReply build()
                           throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<B extends Sim0MQMessage.Builder<B>>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null