|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--fipaos.ont.fipa.ACL
This class provides the representation of an ACL communication within an Agent.
Implements XC00061D & XC00070F (except for support for ":encoding" field)
Field Summary | |
static int |
BYTELENGTH_ENCODING
|
static java.lang.String |
FIPA_OS_SERIALIZATION
ACL Encoding using Java Serialisation |
static java.lang.String |
FIPA00069
ACL Encoding name as defined in FIPA00069 |
static java.lang.String |
FIPA00070
ACL Encoding name as defined in FIPA00070 |
static java.lang.String |
FIPA00071
ACL Encoding name as defined in FIPA00071 |
static int |
STRINGLITERAL_ENCODING
Content encoding constants - see FIPA ACL spec. |
Constructor Summary | |
ACL()
Creates an empty ACL communication |
|
ACL(ACL acl)
Deprecated. Please use clone() instead |
|
ACL(java.lang.String msg)
Creates an ACL object from the given ACL string |
Method Summary | |
void |
addReceiverAID(AgentID aid)
|
void |
addReplyToAID(AgentID aid)
|
static java.lang.String |
byteLengthDecode(java.lang.String in)
Decodes the given String from a ByteLengthEncodedString format (see FIPA ACL definiton) |
static java.lang.String |
byteLengthEncode(java.lang.String in)
Encodes the given String into a ByteLengthEncodedString format (see FIPA ACL definiton) |
java.lang.Object |
clone()
|
java.lang.String |
getContentEncoding()
|
java.lang.Object |
getContentObject()
|
java.lang.String |
getConversationID()
|
java.lang.String |
getInReplyTo()
|
java.lang.String |
getLanguage()
|
java.lang.String |
getOntology()
|
java.lang.String |
getPerformative()
|
java.lang.String |
getProtocol()
|
AgentID |
getReceiverAID()
Get just the first AID of the receivers field, if present |
java.util.List |
getReceiverAIDs()
|
UTCContainer |
getReplyByUTC()
|
java.util.List |
getReplyToAIDs()
|
java.lang.String |
getReplyWith()
|
AgentID |
getSenderAID()
|
void |
setContentEncoding(java.lang.String encoding)
|
void |
setContentObject(java.lang.Object content)
|
void |
setContentObject(java.lang.Object content,
int encode)
Sets the content, optionally encoding the content as the specified type (see FIPA specification), if it is Stringified |
void |
setContentObjectACLParser(java.lang.String s)
Method to be invoked by the ACLParser to set the content - causes outer brakets to be stripped from SL |
void |
setConversationID(java.lang.String conv_id)
|
void |
setInReplyTo(java.lang.String in_reply_to)
|
void |
setLanguage(java.lang.String lang)
|
void |
setOntology(java.lang.String ont)
|
void |
setPerformative(java.lang.String perf)
|
void |
setProtocol(java.lang.String protocol)
|
void |
setReceiverAID(AgentID aid)
|
void |
setReceiverAIDs(java.util.List aids)
|
void |
setReplyByUTC(UTCContainer utc)
|
void |
setReplyToAIDs(java.util.List aids)
|
void |
setReplyWith(java.lang.String reply_with)
|
void |
setSenderAID(AgentID aid)
|
static java.lang.String |
stringLiteralDecode(java.lang.String in)
Decodes the given String from a StringLiteral format (see FIPA ACL definiton) |
static java.lang.String |
stringLiteralEncode(java.lang.String in)
Encodes the given String into a StringLiteral format (see FIPA ACL definiton) |
java.lang.String |
toString()
toString returns a string representation of the message in default ACL encoding |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int STRINGLITERAL_ENCODING
public static final int BYTELENGTH_ENCODING
public static final java.lang.String FIPA00070
public static final java.lang.String FIPA00069
public static final java.lang.String FIPA00071
public static final java.lang.String FIPA_OS_SERIALIZATION
Constructor Detail |
public ACL(ACL acl)
Duplicates the content of the given ACL object
public ACL(java.lang.String msg) throws ParserException
public ACL()
Method Detail |
public java.lang.Object clone()
clone
in class java.lang.Object
public void setSenderAID(AgentID aid)
public AgentID getSenderAID()
public void addReceiverAID(AgentID aid)
public void setReceiverAID(AgentID aid)
public void setReceiverAIDs(java.util.List aids)
public AgentID getReceiverAID()
public java.util.List getReceiverAIDs()
public void addReplyToAID(AgentID aid)
public void setReplyToAIDs(java.util.List aids)
public java.util.List getReplyToAIDs()
public void setContentObjectACLParser(java.lang.String s)
public void setContentObject(java.lang.Object content)
public java.lang.Object getContentObject()
public void setContentObject(java.lang.Object content, int encode)
content
- The content of the messageencode
- Indicates the type of encoding to use for the stringpublic void setContentEncoding(java.lang.String encoding)
public java.lang.String getContentEncoding()
public void setConversationID(java.lang.String conv_id)
public java.lang.String getConversationID()
public void setInReplyTo(java.lang.String in_reply_to)
public java.lang.String getInReplyTo()
public void setLanguage(java.lang.String lang)
public java.lang.String getLanguage()
public void setOntology(java.lang.String ont)
public java.lang.String getOntology()
public void setPerformative(java.lang.String perf)
public java.lang.String getPerformative()
public void setProtocol(java.lang.String protocol)
public java.lang.String getProtocol()
public void setReplyByUTC(UTCContainer utc)
public UTCContainer getReplyByUTC()
public void setReplyWith(java.lang.String reply_with)
public java.lang.String getReplyWith()
public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String stringLiteralEncode(java.lang.String in)
in
- The String to encodepublic static java.lang.String stringLiteralDecode(java.lang.String in)
in
- The String to decodepublic static java.lang.String byteLengthEncode(java.lang.String in)
in
- The String to encodepublic static java.lang.String byteLengthDecode(java.lang.String in)
in
- The String to decode
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |