B
- the actual inherited builder for the return types.public abstract static class Sim0MQMessage.Builder<B extends Sim0MQMessage.Builder<B>> extends Object
Copyright (c) 2016-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.
Modifier and Type | Field and Description |
---|---|
protected long |
messageId
The unique message number is meant to confirm with a callback that the message has been received correctly.
|
protected MessageStatus |
messageStatus
Three different status messages are defined: 1 for new, 2 for change, and 3 for delete.
|
protected Object |
messageTypeId
Message type ids can be defined per type of simulation, and can be provided in different types.
|
protected Object |
receiverId
The receiver id can be used to check whether the message is meant for us, or should be discarded (or an error can be
sent if we receive a message not meant for us).
|
protected Object |
senderId
The sender id can be used to send back a message to the sender at some later time.
|
protected Object |
simulationRunId
the Simulation run ids can be provided in different types.
|
Constructor and Description |
---|
Builder()
Empty constructor.
|
Modifier and Type | Method and Description |
---|---|
abstract Sim0MQMessage |
build()
Build the object.
|
B |
setMessageId(long newMessageId) |
protected B |
setMessageStatus(MessageStatus newMessageStatus) |
protected B |
setMessageTypeId(Object newMessageTypeId) |
B |
setReceiverId(Object newReceiverId) |
B |
setSenderId(Object newSenderId) |
B |
setSimulationRunId(Object newSimulationRunId) |
protected Object simulationRunId
protected Object senderId
protected Object receiverId
protected Object messageTypeId
protected long messageId
protected MessageStatus messageStatus
public final B setSimulationRunId(Object newSimulationRunId)
newSimulationRunId
- set simulationRunIdpublic final B setSenderId(Object newSenderId)
newSenderId
- set senderIdpublic final B setReceiverId(Object newReceiverId)
newReceiverId
- set receiverIdprotected final B setMessageTypeId(Object newMessageTypeId)
newMessageTypeId
- set messageTypeIdpublic final B setMessageId(long newMessageId)
newMessageId
- set messageIdprotected final B setMessageStatus(MessageStatus newMessageStatus)
newMessageStatus
- set messageStatuspublic abstract Sim0MQMessage build() throws Sim0MQException, NullPointerException
Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is nullCopyright © 2016–2019 Delft University of Technology. All rights reserved.