|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Base interface of every messages manipulated by Dream components. A message
is composed of named chunks and a list of sub messages. More precisely, A
Message
is a naming context for its chunks. This means
that a message can not have two chunks with the same name. In addition a
message can have two chunks with the same type since they have different
names.
Chunk
,
MessageType
Field Summary | |
static Message[] |
EMPTY_MESSAGE_ARRAY
An empty Message array constant. |
Method Summary | |
Object |
getChunk(String name)
Returns a chunk of this message, or null if this message
doesn't have a chunk with the specified name. |
short |
getMessageManagerId()
Returns the id of the message manager that created this message. |
MessageType |
getMessageType()
Returns the type of this message. |
Iterator |
getSubMessageIterator()
Returns an Iterator that iterate over the sub messages of
this message. |
Message[] |
getSubMessages()
Returns an (eventually empty) array containing the sub messages of this message. |
void |
recycle()
Recycles message instance. |
void |
setMessageManagerId(short id)
Sets the id of the message manager that created this message. |
void |
transfertChunkStates(Message newInstance)
Transferts the state of the message's chunks into the specified new instance. |
Field Detail |
public static final Message[] EMPTY_MESSAGE_ARRAY
Message
array constant. This constant should be
used by classes requiring an empty Message
array.
Method Detail |
public short getMessageManagerId()
public void setMessageManagerId(short id)
id
- the id of the message manager that created this message.public Object getChunk(String name)
null
if this message
doesn't have a chunk with the specified name.
name
- the name of the chunk, as specified in the message type.
public Iterator getSubMessageIterator()
Iterator
that iterate over the sub messages of
this message.
public Message[] getSubMessages()
public MessageType getMessageType()
public void transfertChunkStates(Message newInstance)
Note: the given new isntance contains all the chunks contained in this message.
newInstance
- the new instance of message.public void recycle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |