Package org.sim0mq.message.modelcontroller

Class MC3StatisticsMessage.Builder

java.lang.Object

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

org.sim0mq.message.modelcontroller.MC3StatisticsMessage.Builder

Enclosing class:

MC3StatisticsMessage

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

Builder for the StartFederate Message. 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.

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
MC3StatisticsMessage	build()	Build the object.
final MC3StatisticsMessage.Builder	setVariableName(String newVariableName)
final MC3StatisticsMessage.Builder	setVariableValue(Object newVariableValue)

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

setVariableName

public final MC3StatisticsMessage.Builder setVariableName(String newVariableName)

Parameters:

newVariableName - set variable name

Returns:

the original object for chaining

setVariableValue

public final MC3StatisticsMessage.Builder setVariableValue(Object newVariableValue)

Parameters:

newVariableValue - set variable value

Returns:

the original object for chaining

build

public MC3StatisticsMessage build()
                           throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<MC3StatisticsMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null