Package jade.core.messaging

Class GenericMessage

java.lang.Object

jade.core.messaging.GenericMessage

All Implemented Interfaces:

Serializable, Serializable

Direct Known Subclasses:

MultipleGenericMessage

public class GenericMessage
extends Object
implements Serializable

Generic class to manage a unified representation of messages (ACLMessage or Payload+Envelope)

Version:

$Date$ $Revision$

Author:

Jerome Picault - Motorola Labs

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GenericMessage()
GenericMessage(Envelope env, byte[] payload)
GenericMessage(ACLMessage msg)

Method Summary

Modifier and Type	Method	Description
ACLMessage	getACLMessage()
Envelope	getEnvelope()
int	getMessagesCnt()
byte[]	getPayload()
AID	getSender()
long	getTimeStamp()
String	getTraceID()
boolean	isAMSFailure()
boolean	isModifiable()
int	length()
void	setACLMessage(ACLMessage msg)
void	setAMSFailure(boolean b)
protected void	setEnvelope(Envelope envelope)
void	setModifiable(boolean b)	Allow setting the value of the modifiable flag.
void	setSender(AID sender)
void	setTimeStamp(long timeStamp)
void	setTraceID(String id)
String	toString()
void	update(ACLMessage msg, Envelope env, byte[] payload)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericMessage

public GenericMessage()

GenericMessage

public GenericMessage(ACLMessage msg)

GenericMessage

public GenericMessage(Envelope env,
                      byte[] payload)

Method Detail

getPayload

public final byte[] getPayload()

getEnvelope

public final Envelope getEnvelope()

setEnvelope

protected void setEnvelope(Envelope envelope)

getACLMessage

public final ACLMessage getACLMessage()

setACLMessage

public final void setACLMessage(ACLMessage msg)

update

public final void update(ACLMessage msg,
                         Envelope env,
                         byte[] payload)

isAMSFailure

public final boolean isAMSFailure()

setAMSFailure

public final void setAMSFailure(boolean b)

isModifiable

public final boolean isModifiable()

setModifiable

public final void setModifiable(boolean b)

Allow setting the value of the modifiable flag. If this flag is true (default) the MessageManager, when receiving a GenericMessage with the payload already set, nullifies the content slot of the embedded ACLMessage to save space.

getTraceID

public final String getTraceID()

setTraceID

public final void setTraceID(String id)

getTimeStamp

public final long getTimeStamp()

setTimeStamp

public final void setTimeStamp(long timeStamp)

setSender

public final void setSender(AID sender)

getSender

public final AID getSender()

toString

public String toString()

Overrides:

toString in class Object

length

public int length()

getMessagesCnt

public int getMessagesCnt()