jade.domain.FIPAAgentManagement
Class Envelope

java.lang.Object
  |
  +--jade.domain.FIPAAgentManagement.Envelope

public class Envelope
extends java.lang.Object
implements Concept, Serializable

See Also:
Serialized Form

Constructor Summary
Envelope()
          Constructor.
 
Method Summary
 void addIntendedReceiver(AID id)
           
 void addStamp(ReceivedObject ro)
          Add a received-object stamp to this message envelope.
 void addTo(AID id)
           
 void clearAllIntendedReceiver()
           
 void clearAllTo()
           
 java.lang.Object clone()
           
 java.lang.String getAclRepresentation()
           
 Iterator getAllIntendedReceiver()
           
 Iterator getAllTo()
           
 java.lang.String getComments()
           
 java.util.Date getDate()
           
 AID getFrom()
           
 java.lang.String getPayloadEncoding()
           
 java.lang.Long getPayloadLength()
           
 ReceivedObject getReceived()
           
 ReceivedObject[] getStamps()
          Access the list of all the stamps.
 boolean removeIntendedReceiver(AID id)
           
 boolean removeTo(AID id)
           
 void setAclRepresentation(java.lang.String r)
           
 void setComments(java.lang.String c)
           
 void setDate(java.util.Date d)
           
 void setFrom(AID id)
           
 void setPayloadEncoding(java.lang.String e)
           
 void setPayloadLength(java.lang.Long l)
           
 void setReceived(ReceivedObject ro)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Envelope

public Envelope()
Constructor. Initializes the payloadLength to -1.
Method Detail

addTo

public void addTo(AID id)

removeTo

public boolean removeTo(AID id)

clearAllTo

public void clearAllTo()

getAllTo

public Iterator getAllTo()

setFrom

public void setFrom(AID id)

getFrom

public AID getFrom()

setComments

public void setComments(java.lang.String c)

getComments

public java.lang.String getComments()

setAclRepresentation

public void setAclRepresentation(java.lang.String r)

getAclRepresentation

public java.lang.String getAclRepresentation()

setPayloadLength

public void setPayloadLength(java.lang.Long l)

getPayloadLength

public java.lang.Long getPayloadLength()

setPayloadEncoding

public void setPayloadEncoding(java.lang.String e)

getPayloadEncoding

public java.lang.String getPayloadEncoding()

setDate

public void setDate(java.util.Date d)

getDate

public java.util.Date getDate()

addIntendedReceiver

public void addIntendedReceiver(AID id)

removeIntendedReceiver

public boolean removeIntendedReceiver(AID id)

clearAllIntendedReceiver

public void clearAllIntendedReceiver()

getAllIntendedReceiver

public Iterator getAllIntendedReceiver()

setReceived

public void setReceived(ReceivedObject ro)

getReceived

public ReceivedObject getReceived()

addStamp

public void addStamp(ReceivedObject ro)
Add a received-object stamp to this message envelope. This method is used by the ACC to add a new stamp to the envelope at every routing hop.
Parameters:
ro - The received-object to add.

getStamps

public ReceivedObject[] getStamps()
Access the list of all the stamps. The received-object stamps are sorted according to the routing path, from the oldest to the newest.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object