net.sf.jiapi.event

Class EventProducer

java.lang.Object

net.sf.jiapi.event.EventProducer

Direct Known Subclasses:

ExceptionEventProducer, FieldEventProducer, FieldInterceptor, FieldInterceptor2, InvocationInterceptor, MethodEventProducer

public class EventProducer
extends Object

Base class for event producers.

Version:

$Revision$ $Date$

Author:

Mika Riekkinen, Joni Suominen

Constructor Summary

Constructors

Constructor and Description
EventProducer() Empty constructor.
EventProducer(String resolution) This constructor will set up resolution to given value.
EventProducer(String[] resolutions) This constructor will set up resolution to given values.

Method Summary

Modifier and Type	Method and Description
String[]	getResolutions() Get the resolutions of this EventProducer.
boolean	isProtected(JiapiEvent je) Checks whether a given JiapiEvent is in protected mode. if JiapiEvent is in protected mode, that event should not be fired.
boolean	isProtected(Object sourceObject) Checks whether a given sourceObject is in protected mode. if sourceObject is in protected mode, corresponding JiapiEvent should not be fired.
boolean	match(String s) Matches a given String into resolution String this EventProducer has.
void	protect(JiapiEvent je) This method protects application from entering into recursive event loop.
void	release(JiapiEvent je) This method releases EventProducer so, that it is able to produce more events for the sourceObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventProducer

public EventProducer()

Empty constructor. This constructor will set up resolution to its default value "*".

EventProducer

public EventProducer(String resolution)

This constructor will set up resolution to given value.

Parameters:

resolution - A resolution that is to be used.

EventProducer

public EventProducer(String[] resolutions)

This constructor will set up resolution to given values.

Parameters:

resolutions - A resolutions that is to be used.

Method Detail

match

public boolean match(String s)

Matches a given String into resolution String this EventProducer has. If at least one resolution matches, a true is returned.

Parameters:

s - String ot match

Returns:

true or false

getResolutions

public String[] getResolutions()

Get the resolutions of this EventProducer.

Returns:

An array of Strings. Each String represents one resolution String, that is used in matching.

isProtected

public boolean isProtected(Object sourceObject)

Checks whether a given sourceObject is in protected mode. if sourceObject is in protected mode, corresponding JiapiEvent should not be fired.

Parameters:

sourceObject - sourceObject to check

Returns:

true or false

isProtected

public boolean isProtected(JiapiEvent je)

Checks whether a given JiapiEvent is in protected mode. if JiapiEvent is in protected mode, that event should not be fired.

Parameters:

je - JiapiEvent to check

Returns:

true or false

protect

public void protect(JiapiEvent je)

This method protects application from entering into recursive event loop. This situation may occur, if a method has been instrumented, and instrumentation produces an event. If that method is called, directly or indirectly, with the aid of JiapiEvent, application will enter to an endless event loop, eventually crashing Virtual Machine.

Calling this method prevents EventProducer from producing further events for the same sourceObject. This protection mechanism allows applications to call methods of sourceObject and targetObject without worrying about event loops.

To enable events again, one will have to release EventProducer with method release.

Parameters:

je - JiapiEvent

See Also:

release(JiapiEvent), JiapiEvent.protect()

release

public void release(JiapiEvent je)

This method releases EventProducer so, that it is able to produce more events for the sourceObject.

Parameters:

je - JiapiEvent

See Also:

protect(JiapiEvent), JiapiEvent.release()