org.sim0mq.message.federationmanager

Class StartFederateMessage.Builder

java.lang.Object

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

org.sim0mq.message.federationmanager.StartFederateMessage.Builder

Enclosing class:

StartFederateMessage

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

Builder for the StartFederate 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.
StartFederateMessage.Builder	setArgsAfter(String newArgsAfter)
StartFederateMessage.Builder	setArgsBefore(String newArgsBefore)
StartFederateMessage.Builder	setDeleteStderr(boolean newDeleteStderr)
StartFederateMessage.Builder	setDeleteStdout(boolean newDeleteStdout)
StartFederateMessage.Builder	setDeleteWorkingDirectory(boolean newDeleteWorkingDirectory)
StartFederateMessage.Builder	setInstanceId(String newInstanceId)
StartFederateMessage.Builder	setModelPath(String newModelPath)
StartFederateMessage.Builder	setRedirectStderr(String rewRedirectStderr)
StartFederateMessage.Builder	setRedirectStdin(String newRedirectStdin)
StartFederateMessage.Builder	setRedirectStdout(String newRedirectStdout)
StartFederateMessage.Builder	setSoftwareCode(String newSoftwareCode)
StartFederateMessage.Builder	setWorkingDirectory(String newWorkingDirectory)

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 StartFederateMessage.Builder setInstanceId(String newInstanceId)

Parameters:

newInstanceId - set instanceId

Returns:

the original object for chaining

setSoftwareCode

public final StartFederateMessage.Builder setSoftwareCode(String newSoftwareCode)

Parameters:

newSoftwareCode - set softwareCode

Returns:

the original object for chaining

setArgsBefore

public final StartFederateMessage.Builder setArgsBefore(String newArgsBefore)

Parameters:

newArgsBefore - set argsBefore

Returns:

the original object for chaining

setModelPath

public final StartFederateMessage.Builder setModelPath(String newModelPath)

Parameters:

newModelPath - set modelPath

Returns:

the original object for chaining

setArgsAfter

public final StartFederateMessage.Builder setArgsAfter(String newArgsAfter)

Parameters:

newArgsAfter - set argsAfter

Returns:

the original object for chaining

setWorkingDirectory

public final StartFederateMessage.Builder setWorkingDirectory(String newWorkingDirectory)

Parameters:

newWorkingDirectory - set workingDirectory

Returns:

the original object for chaining

setRedirectStdin

public final StartFederateMessage.Builder setRedirectStdin(String newRedirectStdin)

Parameters:

newRedirectStdin - set redirectStdin

Returns:

the original object for chaining

setRedirectStdout

public final StartFederateMessage.Builder setRedirectStdout(String newRedirectStdout)

Parameters:

newRedirectStdout - set redirectStdout

Returns:

the original object for chaining

setRedirectStderr

public final StartFederateMessage.Builder setRedirectStderr(String rewRedirectStderr)

Parameters:

rewRedirectStderr - set redirectStderr

Returns:

the original object for chaining

setDeleteWorkingDirectory

public final StartFederateMessage.Builder setDeleteWorkingDirectory(boolean newDeleteWorkingDirectory)

Parameters:

newDeleteWorkingDirectory - set deleteWorkingDirectory

Returns:

the original object for chaining

setDeleteStdout

public final StartFederateMessage.Builder setDeleteStdout(boolean newDeleteStdout)

Parameters:

newDeleteStdout - set deleteStdout

Returns:

the original object for chaining

setDeleteStderr

public final StartFederateMessage.Builder setDeleteStderr(boolean newDeleteStderr)

Parameters:

newDeleteStderr - set deleteStderr

Returns:

the original object for chaining

build

public Sim0MQMessage build()
                    throws Sim0MQException,
                           NullPointerException

Build the object.

Specified by:

build in class Sim0MQMessage.Builder<StartFederateMessage.Builder>

Returns:

the message object from the builder.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null