net.lenni0451.commons.time

Class Timer

java.lang.Object

net.lenni0451.commons.time.Timer

Direct Known Subclasses:

NanoTimer

public class Timer
extends java.lang.Object

A simple class to ensure that a fixed amount of time has passed.
See Timing to wait for a flexible amount of time.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	delay
protected boolean	forcePass
protected long	time

Constructor Summary

Constructors

Constructor and Description
Timer(long delay)

Method Summary

Modifier and Type	Method and Description
void	forcePass() Force the timer to tick.
long	getDelay()
long	getPassedTime()
long	getTime()
boolean	hasPassed() Check if the delay has passed.
void	reset() Reset the time.
long	timeUntil()
long	waitUntil() Wait until the delay has passed.

Methods inherited from class java.lang.Object

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

Field Detail

delay

protected final long delay

time

protected long time

forcePass

protected boolean forcePass

Constructor Detail

Timer

public Timer(long delay)

Method Detail

getDelay

public long getDelay()

Returns:

The delay of this timer

getTime

public long getTime()

Returns:

The time since the last reset

reset

public void reset()

Reset the time.

forcePass

public void forcePass()

Force the timer to tick.

getPassedTime

public long getPassedTime()

Returns:

The time that has passed since the last reset

hasPassed

public boolean hasPassed()

Check if the delay has passed.
The time will be reset if it has passed.

Returns:

If the delay has passed

timeUntil

public long timeUntil()

Returns:

The time until the delay has passed

waitUntil

public long waitUntil()
               throws java.lang.InterruptedException

Wait until the delay has passed.
The time will be reset after the delay has passed.
The thread will not be paused if the delay has already passed or if forcePass() has been called.

Returns:

The amount of time the thread was paused, may be smaller than 0

Throws:

java.lang.InterruptedException - If the thread is interrupted