net.sf.jiapi.event

Class MethodEvent

java.lang.Object

java.util.EventObject

net.sf.jiapi.event.JiapiEvent

net.sf.jiapi.event.MethodEvent

All Implemented Interfaces:

Serializable

public class MethodEvent
extends JiapiEvent

MethodEvent objects are used to identify methods that are entered or exited.

Version:

$Revision$ $Date$

Author:

Mika Riekkinen, Joni Suominen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	METHOD_ENTERED Constant used as an id of the MethodEvent
static int	METHOD_EXITED Constant used as an id of the MethodEvent

Fields inherited from class net.sf.jiapi.event.JiapiEvent

id, sourceObject, target, targetName

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
MethodEvent(MethodEventProducer mep, Object sourceObject, String methodName, int id) Constructor.
MethodEvent(MethodEventProducer mep, Object sourceObject, String methodName, Object target, Object[] methodArgs, int id) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getClassName() Get the name of the class producing this event.
Object[]	getMethodArgs() Get the arguments.
String	getMethodName() Get the name of the method producing this event.
boolean	isConstructor() Is this method a constructor?
boolean	isStaticInitializer() Is this method a static initializer.

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

finalize, getSourceObject, getTarget, getTargetName, protect, release, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_ENTERED

public static final int METHOD_ENTERED

Constant used as an id of the MethodEvent

See Also:

Constant Field Values

METHOD_EXITED

public static final int METHOD_EXITED

Constant used as an id of the MethodEvent

See Also:

Constant Field Values

Constructor Detail

MethodEvent

public MethodEvent(MethodEventProducer mep,
                   Object sourceObject,
                   String methodName,
                   int id)

Constructor. Target and method args are set to null.

Parameters:

mep - an instance of MethodEventProducer

sourceObject - A Source Object. On static methods, this is the Class, that method belongs to. Otherwise Source Object is 'this'.

methodName - Name of the method

id - METHOD_ENTERED or METHOD_EXITED values should be used

MethodEvent

public MethodEvent(MethodEventProducer mep,
                   Object sourceObject,
                   String methodName,
                   Object target,
                   Object[] methodArgs,
                   int id)

Constructor.

Parameters:

mep - an instance of MethodEventProducer

sourceObject - A Source Object. On static methods, this is the Class, that method belongs to. Otherwise Source Object is 'this'.

methodName - Name of the method

target - 'this'

methodArgs - arguments of the method

id - METHOD_ENTERED or METHOD_EXITED values should be used

Method Detail

getMethodArgs

public Object[] getMethodArgs()

Get the arguments.

Returns:

arguments, or null, if they were not given.

getClassName

public String getClassName()

Get the name of the class producing this event.

Returns:

name of the class producing this event

getMethodName

public String getMethodName()

Get the name of the method producing this event.

Returns:

name of the method

isConstructor

public boolean isConstructor()

Is this method a constructor?

Returns:

true, if this MethoEvent was triggered by constructor.

isStaticInitializer

public boolean isStaticInitializer()

Is this method a static initializer.

Returns:

true, if this MethoEvent was triggered by static initializer.