org.arl.fjage

Class GenericMessage

java.lang.Object

org.arl.fjage.Message

org.arl.fjage.GenericMessage

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.Object,java.lang.Object>

public class GenericMessage
extends Message
implements java.util.Map<java.lang.Object,java.lang.Object>

A message class that can convey generic messages represented by key-value pairs.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class org.arl.fjage.Message

inReplyTo, msgID, perf, recipient, sender, sentAt

Constructor Summary

Constructors

Constructor and Description
GenericMessage() Creates an empty generic message.
GenericMessage(AgentID recipient) Creates a generic new message.
GenericMessage(AgentID recipient, Performative perf) Creates a generic new message.
GenericMessage(Message inReplyTo) Creates a generic response message.
GenericMessage(Message inReplyTo, Performative perf) Creates a generic response message.
GenericMessage(Performative perf) Creates a generic new message.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>>	entrySet()
java.lang.Object	get(java.lang.Object key)
double	get(java.lang.Object key, double defVal) Gets the double value associated with a key.
int	get(java.lang.Object key, int defVal) Gets the integer value associated with a key.
long	get(java.lang.Object key, long defVal) Gets the long value associated with a key.
java.lang.String	get(java.lang.Object key, java.lang.String defVal) Gets the string value associated with a key.
boolean	isEmpty()
java.util.Set<java.lang.Object>	keySet()
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> map)
java.lang.Object	remove(java.lang.Object key)
int	size()
java.util.Collection<java.lang.Object>	values()

Methods inherited from class org.arl.fjage.Message

getInReplyTo, getJsonCache, getMessageID, getPerformative, getRecipient, getSender, getSentAt, setInReplyTo, setJsonCache, setMessageID, setPerformative, setRecipient, setSender, setSentAt, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GenericMessage

public GenericMessage()

Creates an empty generic message.

GenericMessage

public GenericMessage(Performative perf)

Creates a generic new message.

Parameters:

perf - performative.

GenericMessage

public GenericMessage(AgentID recipient)

Creates a generic new message.

Parameters:

recipient - agent id of recipient agent or topic.

GenericMessage

public GenericMessage(AgentID recipient,
                      Performative perf)

Creates a generic new message.

Parameters:

recipient - agent id of recipient agent or topic.

perf - performative.

GenericMessage

public GenericMessage(Message inReplyTo)

Creates a generic response message.

Parameters:

inReplyTo - message to which this response corresponds to.

GenericMessage

public GenericMessage(Message inReplyTo,
                      Performative perf)

Creates a generic response message.

Parameters:

inReplyTo - message to which this response corresponds to.

perf - performative.

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Object,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Object,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Object,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.Object,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Object,java.lang.Object>

keySet

public java.util.Set<java.lang.Object> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Object,java.lang.Object>

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map<java.lang.Object,java.lang.Object>

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Object,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> map)

Specified by:

putAll in interface java.util.Map<java.lang.Object,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Object,java.lang.Object>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.Object,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.Object,java.lang.Object>

get

public java.lang.String get(java.lang.Object key,
                            java.lang.String defVal)

Gets the string value associated with a key.

Parameters:

key - the key.

defVal - default value to return, if the key is not found.

Returns:

the string value associated with the key, or defVal if not found.

get

public int get(java.lang.Object key,
               int defVal)

Gets the integer value associated with a key.

Parameters:

key - the key.

defVal - default value to return, if the key is not found.

Returns:

the integer value associated with the key, or defVal if not found.

Throws:

java.lang.NumberFormatException - if the value is not numeric.

get

public long get(java.lang.Object key,
                long defVal)

Gets the long value associated with a key.

Parameters:

key - the key.

defVal - default value to return, if the key is not found.

Returns:

the long value associated with the key, or defVal if not found.

Throws:

java.lang.NumberFormatException - if the value is not numeric.

get

public double get(java.lang.Object key,
                  double defVal)

Gets the double value associated with a key.

Parameters:

key - the key.

defVal - default value to return, if the key is not found.

Returns:

the double value associated with the key, or defVal if not found.

Throws:

java.lang.NumberFormatException - if the value is not numeric.