org.sim0mq.message.federatestarter

Class FederateStartedMessage.Builder

java.lang.Object

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

org.sim0mq.message.federatestarter.FederateStartedMessage.Builder

Enclosing class:

FederateStartedMessage

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

Builder for the FederateStarted Message. Can string setters together, and call build() at the end to build the actual message.

Copyright (c) 2016-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Apr 22, 2017

Author:

Alexander Verbraeck

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage.Builder

messageId, messageStatus, messageTypeId, receiverId, senderId, simulationRunId

Constructor Summary

Constructors

Constructor and Description
Builder() Empty constructor.

Method Summary

Modifier and Type	Method and Description
Sim0MQMessage	build() Build the object.
FederateStartedMessage.Builder	setError(String newError)
FederateStartedMessage.Builder	setInstanceId(String newInstanceId)
FederateStartedMessage.Builder	setModelPort(int newModelPort)
FederateStartedMessage.Builder	setStatus(String newStatus)

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

setMessageId, setMessageStatus, setMessageTypeId, setReceiverId, setSenderId, setSimulationRunId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Empty constructor.

Method Detail

setInstanceId

public final FederateStartedMessage.Builder setInstanceId(String newInstanceId)

Parameters:

newInstanceId - set instanceId

Returns:

the original object for chaining

setStatus

public final FederateStartedMessage.Builder setStatus(String newStatus)

Parameters:

newStatus - set status

Returns:

the original object for chaining

setModelPort

public final FederateStartedMessage.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 FederateStartedMessage.Builder setError(String newError)

Parameters:

newError - set error

Returns:

the original object for chaining

build

public Sim0MQMessage build()
                    throws Sim0MQException,
                           NullPointerException

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<FederateStartedMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null