visad.collab
Class MessageMonitorEvent

java.lang.Object
  extended by visad.collab.MonitorEvent
      extended by visad.collab.MessageMonitorEvent
All Implemented Interfaces:
Serializable

public class MessageMonitorEvent
extends MonitorEvent

MessageMonitorEvent is the VisAD class for MessageEvent-related events from display monitors. They are sourced by DisplayMonitor objects and received by MonitorCallback objects.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class visad.collab.MonitorEvent
CONTROL_CHANGED, CONTROL_INIT_REQUESTED, MAP_ADDED, MAP_CHANGED, MAP_REMOVED, MAPS_CLEARED, MESSAGE_SENT, REFERENCE_ADDED, REFERENCE_REMOVED, seqNum, type
 
Constructor Summary
MessageMonitorEvent(int type, int originator, MessageEvent msg)
          Creates a MessageMonitorEvent for the specified MessageEvent.
MessageMonitorEvent(int type, MessageEvent msg)
          Creates a MessageMonitorEvent for the specified MessageEvent.
MessageMonitorEvent(MessageEvent msg)
          Creates a MessageMonitorEvent for the specified MessageEvent.
 
Method Summary
 Object clone()
          Returns an exact clone of this object.
 boolean equals(Object o)
          Returns true if the specified object matches this object.
 String getKey()
          Get the key used to uniquely identify this event.
 MessageEvent getMessage()
          Gets the ScalarMap to which this event refers.
 String toString()
          Returns a String representation of this object.
 
Methods inherited from class visad.collab.MonitorEvent
getOriginator, getSequenceNumber, getType, getTypeName, getTypeName, setOriginator
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MessageMonitorEvent

public MessageMonitorEvent(MessageEvent msg)
                    throws RemoteException,
                           VisADException
Creates a MessageMonitorEvent for the specified MessageEvent.

Parameters:
msg - the MessageEvent.
Throws:
VisADException - When a bad type is specified.
RemoteException

MessageMonitorEvent

public MessageMonitorEvent(int type,
                           MessageEvent msg)
                    throws RemoteException,
                           VisADException
Creates a MessageMonitorEvent for the specified MessageEvent.

Parameters:
type - The event type (currently only MonitorEvent.MESSAGE_SENT.)
msg - the MessageEvent.
Throws:
VisADException - When a bad type is specified.
RemoteException

MessageMonitorEvent

public MessageMonitorEvent(int type,
                           int originator,
                           MessageEvent msg)
                    throws RemoteException,
                           VisADException
Creates a MessageMonitorEvent for the specified MessageEvent.

Parameters:
type - The event type (currently only MonitorEvent.MESSAGE_SENT.)
originator - The ID of the connection from which this event came, relative to the receiver of the event.
msg - the MessageEvent.
Throws:
VisADException - When a bad type is specified.
RemoteException
Method Detail

getKey

public String getKey()
Get the key used to uniquely identify this event.

Specified by:
getKey in class MonitorEvent
Returns:
The unique key.

getMessage

public MessageEvent getMessage()
Gets the ScalarMap to which this event refers.


equals

public boolean equals(Object o)
Returns true if the specified object matches this object.

Overrides:
equals in class Object
Parameters:
o - The object to compare.

clone

public Object clone()
Returns an exact clone of this object.

Specified by:
clone in class MonitorEvent

toString

public String toString()
Returns a String representation of this object.

Overrides:
toString in class MonitorEvent