com.sun.util
Class PTimer

java.lang.Object
  com.sun.util.PTimer

Deprecated. This class is kept for backwards compatiability with Personal Java. The java.util.Timer class is the preferred way of implementing timers under the Personal Profile.

public abstract class PTimer
extends Object

A class representing a timer. A timer is responsible for managing a set of timer events specified by timer specifications. When the timer event should be sent, the timer calls the timer specification's notifyListeners method.

Compatibility

The PTimer class is available on PersonalJava implementations, but is not available on J2SE platforms. It is optional on Personal Profile implementations, but has been deprecated. The java.util.timer class should be used instead, except in cases where PersonalJava compatibility is necessary.

Since:

PersonalJava1.0

Constructor Summary

PTimer()
Deprecated.

Method Summary

abstract void	deschedule(PTimerSpec t) Deprecated. Stop events from being delivered.
abstract long	getGranularity() Deprecated. Report the granularity of this timer, i.e.
abstract long	getMinRepeatInterval() Deprecated. Report the minimum interval that this timer can repeat tasks.
static PTimer	getTimer() Deprecated. Returns the default timer for the system.
abstract void	schedule(PTimerSpec t) Deprecated. since Personal Java Spec 1.2, replaced by the new scheduleTimerSpec(com.sun.util.PTimerSpec) method.
abstract PTimerSpec	scheduleTimerSpec(PTimerSpec t) Deprecated. Begins monitoring a PTimerSpec.

Methods inherited from class java.lang.Object

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

Constructor Detail

PTimer

public PTimer()

Deprecated.

Method Detail

getTimer

public static PTimer getTimer()

Deprecated.

Returns the default timer for the system. There may be one PTimer instance per virtual machine, one per applet, one per call to getTimer, or some other platform dependent implementation.

Returns:

A non-null PTimer object.

schedule

public abstract void schedule(PTimerSpec t)

Deprecated. since Personal Java Spec 1.2, replaced by the new scheduleTimerSpec(com.sun.util.PTimerSpec) method.

schedule event delivery according to the PTimerSpec

scheduleTimerSpec

public abstract PTimerSpec scheduleTimerSpec(PTimerSpec t)
                                      throws PTimerScheduleFailedException

Deprecated.

Begins monitoring a PTimerSpec.

When the timer specification should go off, the timer will call PTimerSpec.notifyListeners.

Returns the real PTimerSpec that got scheduled. If you schedule a spec that implies a smaller granularity than this timer can provide, or a repeat timer spec that has a smaller repeating interval than this timer can provide, the timer should round to the closest value and return that value as a PTimerSpec object. An interested application can use accessor methods getMinRepeatInterval() and getGranularity() to obtain the Timer's best knowledge of the Timer's limitation on granularity and repeat interval. If you schedule an absolute specification that should have gone off already, it will go off immediately. If the scheduled specification can not be met at all, the exception PTimerScheduleFailedException should be thrown.

You may schedule a timer specification with multiple timers. You may schedule a timer specification with the same timer multiple times (in which case it will go off multiple times). If you modify a timer specification after it has been scheduled with any timer, the results are unspecified.

Parameters:

t - The timer specification to begin monitoring.

Returns:

The real PTimerSpec that was scheduled.

Throws:

PTimerScheduleFailedException - is thrown when the scheduled spec can not be met at all.

deschedule

public abstract void deschedule(PTimerSpec t)

Deprecated.

Stop events from being delivered. Removes a timer specification from the set of monitored specifications. The descheduling happens as soon as practical, but may not happen immediately. If the timer specification has been scheduled multiple times with this timer, all the schedulings are cancelled.

getMinRepeatInterval

public abstract long getMinRepeatInterval()

Deprecated.

Report the minimum interval that this timer can repeat tasks. For example, it's perfectly reasonable for a Timer to specify that the minimum interval for a repeatedly performed task is 1000 msec in between every run. This is to avoid possible system overloading.

Returns:

The timer's best knowledge of minimum repeat interval in mili-seconds. Return -1 if this timer doesn't know its repeating interval limitation.

getGranularity

public abstract long getGranularity()

Deprecated.

Report the granularity of this timer, i.e. the length of time between "tick"s of this timer.

Returns:

The timer's best knowledge of the granularity in mili-seconds. Return -1 if this timer doesn't know its granularity.