Timer (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.util.Timer

```
public final class Timer
extends java.lang.Object
```
A Timer represents a timer that can be used to measure the time that an activity has taken so far.
When you create a new Timer instance, it starts immediately. If you want to restart it, consider calling restart().
The default methods of this class uses System.currentTimeMillis() in the calculations. But all default methods have an overloaded method that requires a long milliseconds parameter. Prefer to use these overloaded methods whenever you need to call multiple methods at the same "time". Otherwise, the results you get may not end up as you would expect.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors
Constructor and Description

Timer()
Constructs a new Timer instance and starts it.

Timer(long milliseconds)
Constructs a new Timer instance and starts it.

Constructors
Constructor and Description
`Timer()` Constructs a new `Timer` instance and starts it.
`Timer(long milliseconds)` Constructs a new `Timer` instance and starts it.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getHours()` Returns the hours that have passed between the time at which this `Timer` instance was started or restarted and now.
`long`	`getHours(long milliseconds)` Returns the hours that have passed between the time at which this `Timer` instance was started or restarted and `milliseconds`.
`long`	`getMinutes()` Returns the minutes that have passed between the time at which this `Timer` instance was started or restarted and now.
`long`	`getMinutes(long milliseconds)` Returns the minutes that have passed between the time at which this `Timer` instance was started or restarted and `milliseconds`.
`long`	`getMinutesRemaining()` Returns the minutes that have passed between the time at which this `Timer` instance was started or restarted and now, excluding the minutes that are represented by full hours.
`long`	`getMinutesRemaining(long milliseconds)` Returns the minutes that have passed between the time at which this `Timer` instance was started or restarted and `milliseconds`, excluding the minutes that are represented by full hours.
`long`	`getSeconds()` Returns the seconds that have passed between the time at which this `Timer` instance was started or restarted and now.
`long`	`getSeconds(long milliseconds)` Returns the seconds that have passed between the time at which this `Timer` instance was started or restarted and `milliseconds`.
`long`	`getSecondsRemaining()` Returns the seconds that have passed between the time at which this `Timer` instance was started or restarted and now, excluding the seconds that are represented by full hours and minutes.
`long`	`getSecondsRemaining(long milliseconds)` Returns the seconds that have passed between the time at which this `Timer` instance was started or restarted and `milliseconds`, excluding the seconds that are represented by full hours and minutes.
`java.lang.String`	`getTime()` Returns a `String` with the hours, minutes and seconds that have passed between the time at which this `Timer` instance was started or restarted and now.
`java.lang.String`	`getTime(long milliseconds)` Returns a `String` with the hours, minutes and seconds that have passed between the time at which this `Timer` instance was started or restarted and `milliseconds`.
`void`	`restart()` Restarts this `Timer` instance.
`void`	`restart(long milliseconds)` Restarts this `Timer` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Timer
```
public Timer()
```
    Constructs a new Timer instance and starts it.
    Calling this constructor is equivalent to new Timer(System.currentTimeMillis()).
  - Timer
```
public Timer(long milliseconds)
```
    Constructs a new Timer instance and starts it.
    
    Parameters:
    
    milliseconds - the milliseconds to measure from
- Method Detail
  - getTime
```
public java.lang.String getTime()
```
    Returns a String with the hours, minutes and seconds that have passed between the time at which this Timer instance was started or restarted and now.
    Calling this method is equivalent to getTime(System.currentTimeMillis()).
    
    Returns:
    
    a String with the hours, minutes and seconds that have passed between the time at which this Timer instance was started or restarted and now
  - getTime
```
public java.lang.String getTime(long milliseconds)
```
    Returns a String with the hours, minutes and seconds that have passed between the time at which this Timer instance was started or restarted and milliseconds.
    This method uses getHours(milliseconds), getMinutesRemaining(milliseconds) and getSecondsRemaining(milliseconds) to get the hours, minutes and seconds, respectively.
    
    Parameters:
    
    milliseconds - the milliseconds to measure to
    
    Returns:
    
    a String with the hours, minutes and seconds that have passed between the time at which this Timer instance was started or restarted and milliseconds
  - getHours
```
public long getHours()
```
    Returns the hours that have passed between the time at which this Timer instance was started or restarted and now.
    Calling this method is equivalent to getHours(System.currentTimeMillis()).
    
    Returns:
    
    the hours that have passed between the time at which this Timer instance was started or restarted and now
  - getHours
```
public long getHours(long milliseconds)
```
    Returns the hours that have passed between the time at which this Timer instance was started or restarted and milliseconds.
    
    Parameters:
    
    milliseconds - the milliseconds to measure to
    
    Returns:
    
    the hours that have passed between the time at which this Timer instance was started or restarted and milliseconds
  - getMinutes
```
public long getMinutes()
```
    Returns the minutes that have passed between the time at which this Timer instance was started or restarted and now.
    Calling this method is equivalent to getMinutes(System.currentTimeMillis()).
    
    Returns:
    
    the minutes that have passed between the time at which this Timer instance was started or restarted and now
  - getMinutes
```
public long getMinutes(long milliseconds)
```
    Returns the minutes that have passed between the time at which this Timer instance was started or restarted and milliseconds.
    
    Parameters:
    
    milliseconds - the milliseconds to measure to
    
    Returns:
    
    the minutes that have passed between the time at which this Timer instance was started or restarted and milliseconds
  - getMinutesRemaining
```
public long getMinutesRemaining()
```
    Returns the minutes that have passed between the time at which this Timer instance was started or restarted and now, excluding the minutes that are represented by full hours.
    Calling this method is equivalent to getMinutesRemaining(System.currentTimeMillis()).
    
    Returns:
    
    the minutes that have passed between the time at which this Timer instance was started or restarted and now, excluding the minutes that are represented by full hours
  - getMinutesRemaining
```
public long getMinutesRemaining(long milliseconds)
```
    Returns the minutes that have passed between the time at which this Timer instance was started or restarted and milliseconds, excluding the minutes that are represented by full hours.
    
    Parameters:
    
    milliseconds - the milliseconds to measure to
    
    Returns:
    
    the minutes that have passed between the time at which this Timer instance was started or restarted and milliseconds, excluding the minutes that are represented by full hours
  - getSeconds
```
public long getSeconds()
```
    Returns the seconds that have passed between the time at which this Timer instance was started or restarted and now.
    Calling this method is equivalent to getSeconds(System.currentTimeMillis()).
    
    Returns:
    
    the seconds that have passed between the time at which this Timer instance was started or restarted and now
  - getSeconds
```
public long getSeconds(long milliseconds)
```
    Returns the seconds that have passed between the time at which this Timer instance was started or restarted and milliseconds.
    
    Parameters:
    
    milliseconds - the milliseconds to measure to
    
    Returns:
    
    the seconds that have passed between the time at which this Timer instance was started or restarted and milliseconds
  - getSecondsRemaining
```
public long getSecondsRemaining()
```
    Returns the seconds that have passed between the time at which this Timer instance was started or restarted and now, excluding the seconds that are represented by full hours and minutes.
    Calling this method is equivalent to getSecondsRemaining(System.currentTimeMillis()).
    
    Returns:
    
    the seconds that have passed between the time at which this Timer instance was started or restarted and now, excluding the seconds that are represented by full hours and minutes
  - getSecondsRemaining
```
public long getSecondsRemaining(long milliseconds)
```
    Returns the seconds that have passed between the time at which this Timer instance was started or restarted and milliseconds, excluding the seconds that are represented by full hours and minutes.
    
    Parameters:
    
    milliseconds - the milliseconds to measure to
    
    Returns:
    
    the seconds that have passed between the time at which this Timer instance was started or restarted and milliseconds, excluding the seconds that are represented by full hours and minutes
  - restart
```
public void restart()
```
    Restarts this Timer instance.
    Calling this method is equivalent to restart(System.currentTimeMillis()).
  - restart
```
public void restart(long milliseconds)
```
    Restarts this Timer instance.
    
    Parameters:
    
    milliseconds - the milliseconds to measure from

Class Timer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Timer

Timer

Method Detail

getTime

getTime

getHours

getHours

getMinutes

getMinutes

getMinutesRemaining

getMinutesRemaining

getSeconds

getSeconds

getSecondsRemaining

getSecondsRemaining

restart

restart