Class FS2FederateStartedMessage.Builder
- java.lang.Object
-
- org.sim0mq.message.Sim0MQMessage.Builder<FS2FederateStartedMessage.Builder>
-
- org.sim0mq.message.federatestarter.FS2FederateStartedMessage.Builder
-
- Enclosing class:
- FS2FederateStartedMessage
public static class FS2FederateStartedMessage.Builder extends Sim0MQMessage.Builder<FS2FederateStartedMessage.Builder>
Builder for the FederateStarted Message. Can string setters together, and call build() at the end to build the actual message.Copyright (c) 2016-2020 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FS2FederateStartedMessage
build()
Build the object.FS2FederateStartedMessage.Builder
setError(String newError)
FS2FederateStartedMessage.Builder
setInstanceId(Object newInstanceId)
FS2FederateStartedMessage.Builder
setModelPort(int newModelPort)
FS2FederateStartedMessage.Builder
setStatus(String newStatus)
-
Methods inherited from class org.sim0mq.message.Sim0MQMessage.Builder
setMessageId, setMessageTypeId, setReceiverId, setSenderId, setSimulationRunId
-
-
-
-
Method Detail
-
setInstanceId
public final FS2FederateStartedMessage.Builder setInstanceId(Object newInstanceId)
- Parameters:
newInstanceId
- set instanceId- Returns:
- the original object for chaining
-
setStatus
public final FS2FederateStartedMessage.Builder setStatus(String newStatus)
- Parameters:
newStatus
- set status- Returns:
- the original object for chaining
-
setModelPort
public final FS2FederateStartedMessage.Builder setModelPort(int newModelPort)
- Parameters:
newModelPort
- set modelPort (int instead of short because of signed short in Java)- Returns:
- the original object for chaining
-
setError
public final FS2FederateStartedMessage.Builder setError(String newError)
- Parameters:
newError
- set error- Returns:
- the original object for chaining
-
build
public FS2FederateStartedMessage build() throws Sim0MQException, NullPointerException
Build the object.- Specified by:
build
in classSim0MQMessage.Builder<FS2FederateStartedMessage.Builder>
- Returns:
- the message object from the builder.
- Throws:
Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is null
-
-