Package org.sim0mq.message.heartbeat

Class HB1HeartbeatMessage.Builder

java.lang.Object

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

org.sim0mq.message.heartbeat.HB1HeartbeatMessage.Builder

Enclosing class:

HB1HeartbeatMessage

public static class HB1HeartbeatMessage.Builder
extends Sim0MQMessage.Builder<HB1HeartbeatMessage.Builder>

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

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

Author:

Alexander Verbraeck

Field Summary

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
HB1HeartbeatMessage	build()	Build the object.

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

Constructor Details

Builder

public Builder()

Empty constructor.

Method Details

build

public HB1HeartbeatMessage build()
                          throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<HB1HeartbeatMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null