io.jbotsim.core

Class Message

java.lang.Object

io.jbotsim.core.Properties

io.jbotsim.core.Message

public final class Message
extends Properties

The Message object simply encodes a message exchanged by two Nodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	content
protected Node	destination
protected String	flag
protected boolean	retryMode
protected Node	sender

Fields inherited from class io.jbotsim.core.Properties

properties

Constructor Summary

Constructors

Constructor and Description
Message() Default constructor with empty content
Message(Message message) Copy constructor.
Message(Object content)
Message(Object content, String flag)

Method Summary

Modifier and Type	Method and Description
Object	getContent() The content of this message, which may be an object of any class.
Node	getDestination() The destination of this message.
String	getFlag() The flag of this message.
Node	getSender() The sender of this message.
boolean	isRetryModeEnabled() The retry mode status.
String	toString()
Message	withDestination(Node newDestination) Copy the current message, changing only the destination.

Methods inherited from class io.jbotsim.core.Properties

addPropertyListener, getProperty, hasProperty, removeProperty, removePropertyListener, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

sender

protected Node sender

destination

protected Node destination

content

protected Object content

retryMode

protected boolean retryMode

flag

protected String flag

Constructor Detail

Message

public Message()

Default constructor with empty content

Message

public Message(Object content)

Parameters:

content - The content of this message. It may be an object of any class, whose reference is going to be shared between sender and destination (no copy).

Message

public Message(Object content,
               String flag)

Parameters:

content - The content of this message. It may be an object of any class, whose reference is going to be shared between sender and destination (no copy).

flag - A custom flag for this message

Message

public Message(Message message)

Copy constructor.

Parameters:

message - The original message to be copied.

Method Detail

withDestination

public Message withDestination(Node newDestination)

Copy the current message, changing only the destination.

Parameters:

newDestination - The new destination of the message.

Returns:

the new Message object.

getSender

public Node getSender()

The sender of this message.

Returns:

the Node registered as the sender of the message.

getDestination

public Node getDestination()

The destination of this message.

Returns:

the Node registered as the destination of the message.

getContent

public Object getContent()

The content of this message, which may be an object of any class.

Returns:

the content of the message, as an Object.

getFlag

public String getFlag()

The flag of this message.

Returns:

the flag of this message, as a String.

isRetryModeEnabled

public boolean isRetryModeEnabled()

The retry mode status.

Returns:

the retry mode status, as a boolean.

toString

public String toString()

Overrides:

toString in class Object