Package org.sim0mq.message.modelcontroller

Class MC1StatusMessage.Builder

java.lang.Object

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

org.sim0mq.message.Sim0MQReply.Builder<MC1StatusMessage.Builder>

org.sim0mq.message.modelcontroller.MC1StatusMessage.Builder

Enclosing class:

MC1StatusMessage

public static class MC1StatusMessage.Builder
extends Sim0MQReply.Builder<MC1StatusMessage.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.Sim0MQReply.Builder

replyToId

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
MC1StatusMessage	build()	Build the object.
final MC1StatusMessage.Builder	setError(String newError)
final MC1StatusMessage.Builder	setStatus(String newStatus)

Methods inherited from class org.sim0mq.message.Sim0MQReply.Builder

setReplyTo, setReplyToId

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

setStatus

public final MC1StatusMessage.Builder setStatus(String newStatus)

Parameters:

newStatus - set status

Returns:

the original object for chaining

setError

public final MC1StatusMessage.Builder setError(String newError)

Parameters:

newError - set error

Returns:

the original object for chaining

build

public MC1StatusMessage build()
                       throws Sim0MQException,
NullPointerException

Description copied from class: Sim0MQMessage.Builder

Build the object.

Specified by:

build in class Sim0MQReply.Builder<MC1StatusMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null