Package org.sim0mq.message.federationmanager

Class FM3SetParameterMessage.Builder

java.lang.Object

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

org.sim0mq.message.federationmanager.FM3SetParameterMessage.Builder

Enclosing class:

FM3SetParameterMessage

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

Builder for the SetParameter 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
FM3SetParameterMessage	build()	Build the object.
final FM3SetParameterMessage.Builder	setParameterName(String newParameterName)
final FM3SetParameterMessage.Builder	setParameterValue(Object newParameterValue)

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

setParameterName

public final FM3SetParameterMessage.Builder setParameterName(String newParameterName)

Parameters:

newParameterName - set parameter name

Returns:

the original object for chaining

setParameterValue

public final FM3SetParameterMessage.Builder setParameterValue(Object newParameterValue)

Parameters:

newParameterValue - set parameterValue

Returns:

the original object for chaining

build

public FM3SetParameterMessage build()
                             throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<FM3SetParameterMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null