APIdia Launch Partner

Top Description Fields Constructors Methods

com.sun.glass.ui

public abstract Class Timer

Class Inheritance

extends Object

java.lang.Object
com.sun.glass.ui.Timer

Known Direct Subclasses

com.sun.glass.ui.gtk.GtkTimer, com.sun.glass.ui.headless.HeadlessTimer, com.sun.glass.ui.ios.IosTimer, com.sun.glass.ui.mac.MacTimer, com.sun.glass.ui.monocle.MonocleTimer, com.sun.glass.ui.win.WinTimer

Imports

java.lang.annotation.Native

A high-resolution timer. An application may either override its run() method, or pass a Runnable object to the constructor of the Timer class.

The run() method may be invoked on a thread other than the UI thread. If a developer wants to process timer events on the UI thread, they can use the Application.invokeLater/invokeAndWait() API.

Field Summary

Modifier and Type	Field and Description
private double	period
private long	ptr
private final Runnable	runnable
private static final double	SET_PERIOD
private static final double	UNSET_PERIOD

Constructor Summary

Access	Constructor and Description
protected	Timer(Runnable runnable) Constructs a new timer.

Method Summary

Modifier and Type	Method and Description
protected abstract void	_pause(long timer)
protected abstract void	_resume(long timer)
protected abstract long	_start(Runnable runnable)
protected abstract long	_start(Runnable runnable, int period)
protected abstract void	_stop(long timer)
public static int	getMaxPeriod() Returns the maximum timer period supported by the native system.
public static int	getMinPeriod() Returns the minimum timer period supported by the native system.
public synchronized boolean	isRunning() Returns true if the timer is currently running (convenience API: might not need it)
public synchronized void	pause() Pauses the timer.
public synchronized void	resume() Resumes the timer.
public synchronized void	start(int period) Starts the timer.
public synchronized void	start() Start a vsync-based timer if the system supports it.
public synchronized void	stop() Stops the timer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

period	back to summary
private double period

ptr	back to summary
private long ptr

runnable	back to summary
private final Runnable runnable

SET_PERIOD	back to summary
private static final double SET_PERIOD Annotations @Native

UNSET_PERIOD	back to summary
private static final double UNSET_PERIOD Annotations @Native

Constructor Detail

Timer	back to summary
protected Timer(Runnable runnable) Constructs a new timer. If the application overrides the Timer.run(), it should call super.run() in order to run the runnable passed to the constructor.

Method Detail

_pause	back to summary
protected abstract void _pause(long timer)

_resume	back to summary
protected abstract void _resume(long timer)

_start	back to summary
protected abstract long _start(Runnable runnable)

_start	back to summary
protected abstract long _start(Runnable runnable, int period)

_stop	back to summary
protected abstract void _stop(long timer)

getMaxPeriod	back to summary
public static int getMaxPeriod() Returns the maximum timer period supported by the native system.

getMinPeriod	back to summary
public static int getMinPeriod() Returns the minimum timer period supported by the native system.

isRunning	back to summary
public synchronized boolean isRunning() Returns true if the timer is currently running (convenience API: might not need it)

pause	back to summary
public synchronized void pause() Pauses the timer. See JDK-8189926. Timer is paused only from the timer thread.

resume	back to summary
public synchronized void resume() Resumes the timer. See JDK-8189926 Timer can get resumed from different threads.

start	back to summary
public synchronized void start(int period) Starts the timer. The period must be in the range getMinPeriod() .. getMaxPeriod(). If the timer is currently started, it gets stopped before re-starting. If starting the timer fails, the RuntimeException is thrown.

start	back to summary
public synchronized void start() Start a vsync-based timer if the system supports it. A RuntimeException is thrown if the system does not support vsync-based timer or if there was an issue starting the timer.

stop	back to summary
public synchronized void stop() Stops the timer. If a vsync-based timer is stopped, all of the vsync timers currently running will be stopped.