FixedTimeExecutor 1.2.0 API

All Implemented Interfaces:


public final class Clock.FixedTimeExecutor
extends Clock.Executor

Create a new FixedTimeExecutor.

Since:: 0.18.1

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`cycles`
`private final Boolean`	`finished`
`private final Integer`	`repeats`
`private final Long`	`executeEveryNanos`

Constructor Summary

Constructors
Constructor	Description
`Clock.FixedTimeExecutor(Long executeEveryNanos, Integer repeats, Function0<Unit> func)`
`Clock.FixedTimeExecutor(Long executeEveryNanos, Function0<Unit> func)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getCycles()`	amount of times this has executed.
`Boolean`	`getFinished()`
`final Integer`	`getRepeats()`
`Long`	`tick(Long deltaTimeNanos)`	Update this Executor, and execute it if the given amount of time has passed.

Methods inherited from class org.polyfrost.polyui.utils.Clock.Executor
getExecuteEveryNanos
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Clock.FixedTimeExecutor
```
Clock.FixedTimeExecutor(Long executeEveryNanos, Integer repeats, Function0<Unit> func)
```
    Parameters:
    
    repeats - how many times to repeat before stopping.
  - Clock.FixedTimeExecutor
```
Clock.FixedTimeExecutor(Long executeEveryNanos, Function0<Unit> func)
```
- Method Detail
  - getCycles
```
 final Integer getCycles()
```
    amount of times this has executed. Only incremented when repeats is not 0 (i.e. it does not last forever) to prevent numerical overflow and keep method short.
  - getFinished
```
 Boolean getFinished()
```
  - getRepeats
```
 final Integer getRepeats()
```
  - tick
```
 Long tick(Long deltaTimeNanos)
```
    Update this Executor, and execute it if the given amount of time has passed.
    
    Returns:
    
    the amount of time left until the next execution, or `0L if it no longer needs to be executed (has finished)