Scheduler (robolectric-utils 3.0 API)

java.lang.Object
- org.robolectric.util.Scheduler

```
public class Scheduler
extends Object
```
Class that manages a queue of Runnables that are scheduled to run now (or at some time in the future). Runnables that are scheduled to run on the UI thread (tasks, animations, etc) eventually get routed to a Scheduler instance. The execution of a scheduler can be in one of three states:
- paused (pause()): if paused, then no posted events will be run unless the Scheduler is explicitly instructed to do so.
- normal (unPause()): if not paused but not set to idle constantly, then the Scheduler will automatically run any Runnables that are scheduled to run at or before the Scheduler's current time, but it won't automatically run any future events. To run future events the Scheduler needs to have its clock advanced.
- idling constantly: if idleConstantly(boolean) is called with true, then the Scheduler will continue looping through posted events (including future events), advancing its clock as it goes.

Constructor Summary

Constructors
Constructor and Description

Scheduler()

Constructors
Constructor and Description
`Scheduler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`advanceBy(long interval)` Run all runnables that are scheduled to run in the next time interval.
`boolean`	`advanceTo(long endTime)` Run all runnables that are scheduled before the endTime.
`boolean`	`advanceToLastPostedRunnable()` Run all runnables in the queue.
`boolean`	`advanceToNextPostedRunnable()` Run the next runnable in the queue.
`boolean`	`areAnyRunnable()` Determine if any enqueued runnables are enqueued before the current time.
`long`	`getCurrentTime()` Get the current time (as seen by the scheduler).
`void`	`idleConstantly(boolean shouldIdleConstantly)` Set the idle state of the Scheduler.
`boolean`	`isPaused()` Determine if the scheduler is paused.
`void`	`pause()` Pause the scheduler.
`void`	`post(Runnable runnable)` Add a runnable to the queue.
`void`	`postAtFrontOfQueue(Runnable runnable)` Add a runnable to the head of the queue.
`void`	`postDelayed(Runnable runnable, long delayMillis)` Add a runnable to the queue to be run after a delay.
`void`	`remove(Runnable runnable)` Remove a runnable from the queue.
`void`	`reset()` Reset the internal state of the Scheduler.
`boolean`	`runOneTask()` Run the next runnable in the queue.
`int`	`size()` Return the number of enqueued runnables.
`void`	`unPause()` Un-pause the scheduler.

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

- Constructor Detail
  - Scheduler
```
public Scheduler()
```
- Method Detail
  - getCurrentTime
```
public long getCurrentTime()
```
    Get the current time (as seen by the scheduler).
    
    Returns:
    
    Current time.
  - pause
```
public void pause()
```
    Pause the scheduler.
  - unPause
```
public void unPause()
```
    Un-pause the scheduler.
  - isPaused
```
public boolean isPaused()
```
    Determine if the scheduler is paused.
    
    Returns:
    
    true if it is paused.
  - post
```
public void post(Runnable runnable)
```
    Add a runnable to the queue.
    
    Parameters:
    
    runnable - Runnable to add.
  - postDelayed
```
public void postDelayed(Runnable runnable,
                        long delayMillis)
```
    Add a runnable to the queue to be run after a delay.
    
    Parameters:
    
    runnable - Runnable to add.
    
    delayMillis - Delay in millis.
  - postAtFrontOfQueue
```
public void postAtFrontOfQueue(Runnable runnable)
```
    Add a runnable to the head of the queue.
    
    Parameters:
    
    runnable - Runnable to add.
  - remove
```
public void remove(Runnable runnable)
```
    Remove a runnable from the queue.
    
    Parameters:
    
    runnable - Runnable to remove.
  - advanceToLastPostedRunnable
```
public boolean advanceToLastPostedRunnable()
```
    Run all runnables in the queue.
    
    Returns:
    
    True if a runnable was executed.
  - advanceToNextPostedRunnable
```
public boolean advanceToNextPostedRunnable()
```
    Run the next runnable in the queue.
    
    Returns:
    
    True if a runnable was executed.
  - advanceBy
```
public boolean advanceBy(long interval)
```
    Run all runnables that are scheduled to run in the next time interval.
    
    Parameters:
    
    interval - Time interval (in millis).
    
    Returns:
    
    True if a runnable was executed.
  - advanceTo
```
public boolean advanceTo(long endTime)
```
    Run all runnables that are scheduled before the endTime.
    
    Parameters:
    
    endTime - Future time.
    
    Returns:
    
    True if a runnable was executed.
  - runOneTask
```
public boolean runOneTask()
```
    Run the next runnable in the queue.
    
    Returns:
    
    True if a runnable was executed.
  - areAnyRunnable
```
public boolean areAnyRunnable()
```
    Determine if any enqueued runnables are enqueued before the current time.
    
    Returns:
    
    True if any runnables can be executed.
  - reset
```
public void reset()
```
    Reset the internal state of the Scheduler.
  - size
```
public int size()
```
    Return the number of enqueued runnables.
    
    Returns:
    
    Number of enqueues runnables.
  - idleConstantly
```
public void idleConstantly(boolean shouldIdleConstantly)
```
    Set the idle state of the Scheduler.
    
    Parameters:
    
    shouldIdleConstantly - True if the scheduler should idle.

Class Scheduler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Scheduler

Method Detail

getCurrentTime

pause

unPause

isPaused

post

postDelayed

postAtFrontOfQueue

remove

advanceToLastPostedRunnable

advanceToNextPostedRunnable

advanceBy

advanceTo

runOneTask

areAnyRunnable

reset

size

idleConstantly