fipaos.ont.fipa
Class ACL

Direct Known Subclasses:
ACLMessage

public class ACL
implements Cloneable, Serializable

This class provides the representation of an ACL communication within an Agent


Constructor Summary
ACL(String msg)
          Creates an ACL object from the given ACL string
ACL()
          Creates an empty ACL communication

Method Summary
 voidaddReceiverAID(AgentID aid)
           
 voidaddReplyToAID(AgentID aid)
           
 static StringbyteLengthDecode(String in)
          Decodes the given String from a ByteLengthEncodedString format (see FIPA ACL definiton)
 static StringbyteLengthEncode(String in)
          Encodes the given String into a ByteLengthEncodedString format (see FIPA ACL definiton)
 Objectclone()
           
 ObjectgetContentObject()
           
 StringgetConversationID()
           
 StringgetInReplyTo()
           
 StringgetLanguage()
           
 StringgetOntology()
           
 StringgetPerformative()
           
 StringgetProtocol()
           
 ListgetReceiverAIDs()
           
 UTCContainergetReplyByUTC()
           
 ListgetReplyToAIDs()
           
 StringgetReplyWith()
           
 AgentIDgetSenderAID()
           
 voidsetContentObject(Object content)
           
 voidsetConversationID(String conv_id)
           
 voidsetInReplyTo(String in_reply_to)
           
 voidsetLanguage(String lang)
           
 voidsetOntology(String ont)
           
 voidsetPerformative(String perf)
           
 voidsetProtocol(String protocol)
           
 voidsetReceiverAID(AgentID aid)
           
 voidsetReceiverAIDs(List aids)
           
 voidsetReplyByUTC(UTCContainer utc)
           
 voidsetReplyToAIDs(List aids)
           
 voidsetReplyWith(String reply_with)
           
 voidsetSenderAID(AgentID aid)
           
 static StringstringLiteralDecode(String in)
          Decodes the given String from a StringLiteral format (see FIPA ACL definiton)
 static StringstringLiteralEncode(String in)
          Encodes the given String into a StringLiteral format (see FIPA ACL definiton)
 StringtoString()
          toString returns a string representation of the message in default ACL encoding

Constructor Detail

ACL

public ACL(String msg)
throws fipaos.parser.ParserException
Creates an ACL object from the given ACL string

ACL

public ACL()
Creates an empty ACL communication
Method Detail

addReceiverAID

public void addReceiverAID(AgentID aid)

addReplyToAID

public void addReplyToAID(AgentID aid)

byteLengthDecode

public static String byteLengthDecode(String in)
Decodes the given String from a ByteLengthEncodedString format (see FIPA ACL definiton)
Parameters:
in - The String to decode
Returns: The decoded String

byteLengthEncode

public static String byteLengthEncode(String in)
Encodes the given String into a ByteLengthEncodedString format (see FIPA ACL definiton)
Parameters:
in - The String to encode
Returns: The encoded String

clone

public Object clone()

getContentObject

public Object getContentObject()

getConversationID

public String getConversationID()

getInReplyTo

public String getInReplyTo()

getLanguage

public String getLanguage()

getOntology

public String getOntology()

getPerformative

public String getPerformative()

getProtocol

public String getProtocol()

getReceiverAIDs

public List getReceiverAIDs()

getReplyByUTC

public UTCContainer getReplyByUTC()

getReplyToAIDs

public List getReplyToAIDs()

getReplyWith

public String getReplyWith()

getSenderAID

public AgentID getSenderAID()

setContentObject

public void setContentObject(Object content)

setConversationID

public void setConversationID(String conv_id)

setInReplyTo

public void setInReplyTo(String in_reply_to)

setLanguage

public void setLanguage(String lang)

setOntology

public void setOntology(String ont)

setPerformative

public void setPerformative(String perf)

setProtocol

public void setProtocol(String protocol)

setReceiverAID

public void setReceiverAID(AgentID aid)

setReceiverAIDs

public void setReceiverAIDs(List aids)

setReplyByUTC

public void setReplyByUTC(UTCContainer utc)

setReplyToAIDs

public void setReplyToAIDs(List aids)

setReplyWith

public void setReplyWith(String reply_with)

setSenderAID

public void setSenderAID(AgentID aid)

stringLiteralDecode

public static String stringLiteralDecode(String in)
Decodes the given String from a StringLiteral format (see FIPA ACL definiton)
Parameters:
in - The String to decode
Returns: The decoded String

stringLiteralEncode

public static String stringLiteralEncode(String in)
Encodes the given String into a StringLiteral format (see FIPA ACL definiton)
Parameters:
in - The String to encode
Returns: The encoded String

toString

public String toString()
toString returns a string representation of the message in default ACL encoding
Returns: string

Association Links

to Class fipaos.ont.fipa.fipaman.AgentID

AID of the Agent sending the ACL communication

to Class java.util.List

AID('s) of the recipients of the message

to Class java.util.List

Reply-to field of the ACL communication

to Class java.lang.String

Language of the content (only used if this is deparsed into a String form, or is already in a String form)

to Class java.lang.String

Ontology of the content of this ACL communication

to Class java.lang.String

Protocol used within the current conversation

to Class java.lang.String

Conversation-id of the conversation that this communication belongs to

to Class java.lang.String

In-reply-to field of the ACL communication

to Class java.lang.String

Reply-with field of the ACL communication

to Class fipaos.util.UTCContainer

Reply-to field of the ACL communication

to Class java.lang.String

Performative associated with this communication