uchicago.src.sim.util
Class ProbeEvent

java.lang.Object
  uchicago.src.sim.util.ProbeEvent

public class ProbeEvent
extends java.lang.Object

A semantic event that indicates that an object has been probed. ProbeEvents are passed to ProbeListeners' objectProbed and objectUnprobed methods. When used with ProbeListeners ProbeEvent's getPropertyName will return an empty String, and getNewValue will return null. getProbedObject will return the object that has been probed.

Version:

$Revision: 1.4 $ $Date: 2004/11/03 19:51:06 $

Constructor Summary

ProbeEvent(java.lang.Object probedObject)
Constructs a ProbeEvent with the specified probed object.

ProbeEvent(java.lang.Object probedObject, java.lang.String propertyName)
Constructs a ProbeEvent with the specified probed object, and the specified propertyName.

ProbeEvent(java.lang.Object probedObject, java.lang.String propertyName, java.lang.Object newVal)
Constructs a ProbeEvent with the specified probed object, the specified propertyName, and the specified new value of the property.

Method Summary

java.lang.Object	getNewValue() Returns the new value of the property being written.
java.lang.Object	getProbedObject() Returns the object being probed.
java.lang.String	getPropertyName() Returns the property name being written or read.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbeEvent

public ProbeEvent(java.lang.Object probedObject)

Constructs a ProbeEvent with the specified probed object.

Parameters:

probedObject - the object being probed

ProbeEvent

public ProbeEvent(java.lang.Object probedObject,
                  java.lang.String propertyName)

Constructs a ProbeEvent with the specified probed object, and the specified propertyName.

Parameters:

probedObject - the object being probed

propertyName - the name of the property being read

ProbeEvent

public ProbeEvent(java.lang.Object probedObject,
                  java.lang.String propertyName,
                  java.lang.Object newVal)

Constructs a ProbeEvent with the specified probed object, the specified propertyName, and the specified new value of the property.

Parameters:

probedObject - the object being probed

propertyName - the name of the property being written

newVal - the new value of the property being written

Method Detail

getProbedObject

public java.lang.Object getProbedObject()

Returns the object being probed.

getPropertyName

public java.lang.String getPropertyName()

Returns the property name being written or read. This will be an empty string when this ProbeEvent is used with a ProbeListener.

getNewValue

public java.lang.Object getNewValue()

Returns the new value of the property being written. This will be null when this ProbeEvent is used with a ProbeListener.