eve.sys

Class YieldToEvents

java.lang.Object

eve.sys.YieldToEvents

public class YieldToEvents
extends Object

This is a convenience class that can be used to cause the current Thread to yield to GUI events (if any are present) during processor intesive tasks (e.g. decoding HTML text).

The class allows you to specify the minimum interval to wait between yields and the maximum length of time to wait during a yield.

The class calls the Device.yieldToEvents() method to accomplish this. This method will call the GUI yieldToEvents() method if one exists, otherwise the default yieldToEvents() is used.

Constructor Summary

Constructors

Constructor and Description
YieldToEvents(int forHowLong, int atIntervalsOf) Create a new YieldToEvents.

Method Summary

Modifier and Type	Method and Description
void	set(int forHowLong, int atIntervalsOf) Modify the parameters of this YieldToEvents.
boolean	yield() Yield to events if there are pending events and if the minimum interval has elapsed.

Methods inherited from class java.lang.Object

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

Constructor Detail

YieldToEvents

public YieldToEvents(int forHowLong,
                     int atIntervalsOf)

Create a new YieldToEvents.

Parameters:

forHowLong - the maximum length of time in milliseconds to yield.

atIntervalsOf - the minimum length of time in milliseconds to elpase between yields.

Method Detail

set

public void set(int forHowLong,
                int atIntervalsOf)

Modify the parameters of this YieldToEvents.

Parameters:

forHowLong - the maximum length of time in milliseconds to yield.

atIntervalsOf - the minimum length of time in milliseconds to elpase between yields.

yield

public boolean yield()

Yield to events if there are pending events and if the minimum interval has elapsed.

Returns:

true if the minimum interval has elapsed and a yield was at least attempted. false if not.