public class Message extends ParameterElement
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONTENT |
static java.lang.String |
CONVERSATION_ID |
static java.lang.String |
DATE |
static java.lang.String |
DURATION |
static java.lang.String |
ENCODING |
static java.lang.String |
IN_REPLY_TO |
static java.lang.String |
LANGUAGE |
protected jadex.bridge.IMessageAdapter |
message
The original message.
|
static java.util.List |
MESSAGE_ATTRIBUTES
The allowed message attributes.
|
static java.lang.String |
ONTOLOGY |
static java.lang.String |
PERFORMATIVE |
static java.lang.String |
PROTOCOL |
protected Component |
receiver
The receiver of the message
|
static java.lang.String |
RECEIVER |
static java.lang.String |
RECEIVERS |
static java.lang.String |
REPLY_BY |
static java.lang.String |
REPLY_TO |
static java.lang.String |
REPLY_WITH |
protected Component |
sender
The sender of the message
|
static java.lang.String |
SENDER |
static java.lang.String |
SEQ_NO |
protected int |
uniqueId
The unique id (sequence nr) saved for quick access
|
static java.lang.String |
XID |
CLASS, NAME, parameters, visible
Constructor and Description |
---|
Message()
For loading from file.
|
Message(jadex.bridge.IMessageAdapter msg,
int sequence,
jadex.bridge.IComponentIdentifier receiver)
Create a message with given parameters and sequence number.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
applyFilter(MessageFilter[] filter)
Applies a filter on the message and returns if the visibility has changed.
|
int |
compareTo(java.lang.Object o)
Messages are compared by their unique_id.
|
boolean |
equals(java.lang.Object obj)
Only messages with the same unique id are equal.
|
static java.lang.String[] |
getDeclaredParameters()
Get the user defined parameters.
|
edu.uci.ics.jung.graph.util.Pair |
getEndpoints()
Helper method for checking the visibility of the message including the state of sender , receiver and dummy agent
Returns a pair of Agents if the message should be displayed or
null if not. |
java.lang.String |
getId() |
java.lang.Object |
getParameter(java.lang.String name)
Returns a parameter value.
|
java.util.Map |
getParameters()
Returns the parameter map.
|
Component |
getReceiver() |
Component |
getSender() |
int |
getUniqueId() |
int |
hashCode() |
boolean |
hasParameter(java.lang.String name)
Checks if a given parameter is contained by the parameter map.
|
boolean |
isMulticast() |
void |
setDuration(long duration) |
void |
setReceiver(Component agent) |
void |
setSender(Component agent) |
void |
setUniqueId(int uniqueId)
Set the unique id.
|
java.lang.String |
toString() |
isVisible, setParameter, setParameters, setVisible
public static final java.lang.String SEQ_NO
public static final java.lang.String XID
public static final java.lang.String DATE
public static final java.lang.String DURATION
public static final java.lang.String SENDER
public static final java.lang.String RECEIVER
public static final java.lang.String RECEIVERS
public static final java.lang.String PERFORMATIVE
public static final java.lang.String CONTENT
public static final java.lang.String ONTOLOGY
public static final java.lang.String ENCODING
public static final java.lang.String IN_REPLY_TO
public static final java.lang.String LANGUAGE
public static final java.lang.String PROTOCOL
public static final java.lang.String REPLY_BY
public static final java.lang.String REPLY_WITH
public static final java.lang.String REPLY_TO
public static final java.lang.String CONVERSATION_ID
public static final java.util.List MESSAGE_ATTRIBUTES
protected Component sender
protected Component receiver
protected int uniqueId
protected jadex.bridge.IMessageAdapter message
public Message()
arguments
- The parameters of the message.sequence
- The sequence number of the message.public Message(jadex.bridge.IMessageAdapter msg, int sequence, jadex.bridge.IComponentIdentifier receiver)
arguments
- The parameters of the message.sequence
- The sequence number of the message.public static final java.lang.String[] getDeclaredParameters()
public Component getSender()
public Component getReceiver()
public int getUniqueId()
public void setUniqueId(int uniqueId)
uniqueid
- The unique id.public boolean isMulticast()
public edu.uci.ics.jung.graph.util.Pair getEndpoints()
null
if not.null
if the message shouldnt be displayedprotected boolean applyFilter(MessageFilter[] filter)
filter
- The filter to be applied on the message.public void setSender(Component agent)
agent
- The sender to set.public void setReceiver(Component agent)
agent
- The receiver to set.public void setDuration(long duration)
duration
- The duration to set.public java.lang.String getId()
getId
in class ParameterElement
public java.lang.Object getParameter(java.lang.String name)
getParameter
in class ParameterElement
name
- The name of the parameter.public java.util.Map getParameters()
getParameters
in class ParameterElement
public boolean hasParameter(java.lang.String name)
hasParameter
in class ParameterElement
name
- The name of the parameter.true
if the parameter is contained.public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
compareTo
in class ParameterElement
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class ParameterElement
public java.lang.String toString()
toString
in class ParameterElement