net.sf.jiapi.event

Class MethodEventProducer

java.lang.Object

net.sf.jiapi.event.EventProducer

net.sf.jiapi.event.MethodEventProducer

public class MethodEventProducer
extends EventProducer

This class registers itself to Jiapi runtime and tracks method entries and exits. When either event happens it will notify each listeners that has been registered.

If an exception is thrown from a method, the exit event is not produced. That is, exit events are produced only for the normal exits from methods.

Author:

Mika Riekkinen, Joni Suominen

Constructor Summary

Constructors

Constructor and Description
MethodEventProducer(InstrumentationDescriptor id) Constructor.
MethodEventProducer(InstrumentationDescriptor id, String resolution) Creates new MethodEventProducer.

Method Summary

Modifier and Type	Method and Description
void	addMethodListener(MethodListener mel) Adds a MethodListener.
protected void	fireMethodEnterEvent(Object sourceObject, String methodName) Fires an event on method entry.
protected void	fireMethodExitEvent(Object sourceObject, String methodName) Fires an event on method exit.
void	methodEntered(Object sourceObject, String methodName) This method is called by the Jiapi runtime.
void	methodExited(Object sourceObject, String methodName) This method is called by the Jiapi runtime.
void	removeMethodListener(MethodListener mel) Removes a MethodListener.

Methods inherited from class net.sf.jiapi.event.EventProducer

getResolutions, isProtected, isProtected, match, protect, release

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodEventProducer

public MethodEventProducer(InstrumentationDescriptor id)

Constructor. Resolution is set to '*', which indicates all the MethodEvents are produced.

Parameters:

id - Instrumentation decsriptor, that this MethodEventProducer registers itself to.

MethodEventProducer

public MethodEventProducer(InstrumentationDescriptor id,
                           String resolution)

Creates new MethodEventProducer. Only MethodEvents, that match with given resolution, are produced. Resolution is compared against the name of the method during instrumentation.

Parameters:

id - Instrumentation decsriptor, that this MethodEventProducer registers itself to.

resolution - Resolution, that is used further to select which methods will trigger events to be produced.

Method Detail

addMethodListener

public void addMethodListener(MethodListener mel)

Adds a MethodListener.

Parameters:

mel - a MethodListener

removeMethodListener

public void removeMethodListener(MethodListener mel)

Removes a MethodListener.

Parameters:

mel - a MethodListener

methodEntered

public void methodEntered(Object sourceObject,
                          String methodName)

This method is called by the Jiapi runtime. It should not be called by others.

Parameters:

sourceObject - source Object

methodName - Method name

methodExited

public void methodExited(Object sourceObject,
                         String methodName)

This method is called by the Jiapi runtime. It should not be called by others.

Parameters:

sourceObject - source object

methodName - method name

fireMethodEnterEvent

protected void fireMethodEnterEvent(Object sourceObject,
                                    String methodName)

Fires an event on method entry.

Parameters:

sourceObject - Source Object

methodName - Name of the method

fireMethodExitEvent

protected void fireMethodExitEvent(Object sourceObject,
                                   String methodName)

Fires an event on method exit.

Parameters:

sourceObject - Source Object

methodName - Name of the method