All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class uhr.core.msg.MessageStd 

java.lang.Object
   |
   +----uhr.core.tron.PropMapStd
           |
           +----uhr.core.msg.MessageStd
public class MessageStd
extends PropMapStd
implements Message
This interface represents a Message that travels between parts. A Message is a special type of Datatron. It has a name (or ID) and a PropMap. The name is for symantic understanding and routing. The name is always required. Null values are allowed.

Constructor Index

o MessageStd()
Configures the PropMap to allow null values, not have ordered keys, and no key separator (not a tree).

Method Index

o clone()
Returns a shallow copy of the object.
o getName()
Returns the name.
o reuse(String)
A convenience method for Message reuse.
o setName(String)
Sets the Message name.
o toString()
Returns a String representation of the name and key values.

Constructors

o MessageStd 
 public MessageStd()
Configures the PropMap to allow null values, not have ordered keys, and no key separator (not a tree).

Methods

o toString 
 public String toString()
Returns a String representation of the name and key values.

Returns:
the String representation.
Overrides:
toString in class PropMapStd
o clone 
 public Object clone()
Returns a shallow copy of the object.

Returns:
the shallow copy of the object.
Overrides:
clone in class PropMapStd
o setName 
 public void setName(String name)
Sets the Message name. Period separators are encouraged for large systems. Spaces are not allowed.

Note the name must not only semantically describe the Message, but must be unique among all the other Messages in the portion of a system the Message will be used in. When coding names be very careful to avoid spelin mistakkes. :-) The name is case sensitive.

Due to String interning, do NOT use new String("ThisName") to create event names. This may cause Hashtable to fail and is wasteful.

Parameters:
name - the name of the Message.
o getName 
 public String getName()
Returns the name. This is used by MessageReceivers for determining what to do, in a manner similar to method names. For speed and code conciseness you can assume the name has been interned.

Returns:
the interned name.
o reuse 
 public void reuse(String name)
A convenience method for Message reuse. It does a setName() and a removeAll() in a slightly faster manner than two separate method calls. In future versions it may do more.

Parameters:
name - the name of the Message. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index