Package org.sim0mq.message.federatestarter

Class FS4FederateKilledMessage.Builder

java.lang.Object

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

org.sim0mq.message.federatestarter.FS4FederateKilledMessage.Builder

Enclosing class:

FS4FederateKilledMessage

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

Builder for the FederateStarted 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
FS4FederateKilledMessage	build()	Build the object.
final FS4FederateKilledMessage.Builder	setError(String newError)
final FS4FederateKilledMessage.Builder	setInstanceId(String newInstanceId)
final FS4FederateKilledMessage.Builder	setStatus(boolean newStatus)

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

setInstanceId

public final FS4FederateKilledMessage.Builder setInstanceId(String newInstanceId)

Parameters:

newInstanceId - set instanceId

Returns:

the original object for chaining

setStatus

public final FS4FederateKilledMessage.Builder setStatus(boolean newStatus)

Parameters:

newStatus - set status

Returns:

the original object for chaining

setError

public final FS4FederateKilledMessage.Builder setError(String newError)

Parameters:

newError - set error

Returns:

the original object for chaining

build

public FS4FederateKilledMessage build()
                               throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<FS4FederateKilledMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null