org.robolectric.shadows

Class ShadowPausedLooper

java.lang.Object

org.robolectric.shadows.ShadowLooper

org.robolectric.shadows.ShadowPausedLooper

@Implements(value=android.os.Looper.class,
            isInAndroidSdk=false)
public final class ShadowPausedLooper
extends ShadowLooper

The shadow Looper for LooperMode.Mode.PAUSED.

This shadow differs from the legacy ShadowLegacyLooper in the following ways:\ - Has no connection to Scheduler. Its APIs are standalone - The main looper is always paused. Posted messages are not executed unless idle() is called. - Just like in real Android, each looper has its own thread, and posted tasks get executed in that thread. - - There is only a single SystemClock value that all loopers read from. Unlike legacy behavior where each Scheduler kept their own clock value.

This class should not be used directly; use ShadowLooper instead.

Nested Class Summary

Nested classes/interfaces inherited from class org.robolectric.shadows.ShadowLooper

ShadowLooper.Picker

Constructor Summary

Constructors

Constructor and Description
ShadowPausedLooper()

Method Summary

Modifier and Type	Method and Description
protected void	__constructor__(boolean quitAllowed)
Duration	getLastScheduledTaskTime()
Duration	getNextScheduledTaskTime()
org.robolectric.util.Scheduler	getScheduler() Returns the Scheduler that is being used to manage the enqueued tasks.
boolean	hasQuit()
void	idle() Executes all posted tasks scheduled before or at the current time.
void	idleConstantly(boolean shouldIdleConstantly)
void	idleFor(long time, TimeUnit timeUnit) Advances the system clock by the given time, then executes all posted tasks scheduled before or at the given time.
void	idleIfPaused() Helper method to selectively call idle() only if LooperMode is PAUSED.
boolean	isIdle() Returns true if the looper has any pending tasks scheduled to be executed before current time.
boolean	isPaused()
void	pause() Pause the looper.
boolean	post(Runnable runnable, long delayMillis) Enqueue a task to be run later.
boolean	postAtFrontOfQueue(Runnable runnable) Enqueue a task to be run ahead of all other delayed tasks.
protected static void	prepareMainLooper()
protected void	quit()
protected void	quitSafely()
void	quitUnchecked()
void	reset() Causes all enqueued tasks to be discarded, and pause state to be reset
static void	resetLoopers()
void	resetScheduler() Only supported for LooperMode.Mode.PAUSED.
void	runOneTask() Causes only one of the next Runnables that have been scheduled to run while advancing the clock to its start time.
void	runPaused(Runnable runnable) Runs the current task with the looper paused.
void	runToEndOfTasks() Causes all of the Runnables that have been scheduled to run while advancing the clock to the start time of the last scheduled Runnable.
void	runToNextTask() Causes the next Runnable(s) that have been scheduled to run while advancing the clock to its start time.
boolean	setPaused(boolean shouldPause) Control the paused state of the Looper.
void	unPause() Not supported for the main Looper in LooperMode.Mode.PAUSED.

Methods inherited from class org.robolectric.shadows.ShadowLooper

assertLooperMode, getLooperForThread, getShadowMainLooper, idle, idle, idleFor, idleMainLooper, idleMainLooper, idleMainLooper, idleMainLooperConstantly, looperMode, pauseLooper, pauseMainLooper, resetThreadLoopers, runMainLooperOneTask, runMainLooperToNextTask, runUiThreadTasks, runUiThreadTasksIncludingDelayedTasks, shadowMainLooper, unPauseLooper, unPauseMainLooper

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadowPausedLooper

public ShadowPausedLooper()

Method Detail

__constructor__

@Implementation
protected void __constructor__(boolean quitAllowed)

quitUnchecked

public void quitUnchecked()

Specified by:

quitUnchecked in class ShadowLooper

hasQuit

public boolean hasQuit()

Specified by:

hasQuit in class ShadowLooper

idle

public void idle()

Description copied from class: ShadowLooper

Executes all posted tasks scheduled before or at the current time.

Specified by:

idle in class ShadowLooper

idleFor

public void idleFor(long time,
                    TimeUnit timeUnit)

Description copied from class: ShadowLooper

Advances the system clock by the given time, then executes all posted tasks scheduled before or at the given time.

Specified by:

idleFor in class ShadowLooper

isIdle

public boolean isIdle()

Description copied from class: ShadowLooper

Returns true if the looper has any pending tasks scheduled to be executed before current time.

Specified by:

isIdle in class ShadowLooper

unPause

public void unPause()

Description copied from class: ShadowLooper

Not supported for the main Looper in LooperMode.Mode.PAUSED.

Specified by:

unPause in class ShadowLooper

pause

public void pause()

Description copied from class: ShadowLooper

Pause the looper.

Has no practical effect for realistic looper, since it is always paused.

Specified by:

pause in class ShadowLooper

isPaused

public boolean isPaused()

Specified by:

isPaused in class ShadowLooper

setPaused

public boolean setPaused(boolean shouldPause)

Description copied from class: ShadowLooper

Control the paused state of the Looper.

Not supported for the main Looper in LooperMode.Mode.PAUSED.

Specified by:

setPaused in class ShadowLooper

resetScheduler

public void resetScheduler()

Description copied from class: ShadowLooper

Only supported for LooperMode.Mode.PAUSED.

Specified by:

resetScheduler in class ShadowLooper

reset

public void reset()

Description copied from class: ShadowLooper

Causes all enqueued tasks to be discarded, and pause state to be reset

Specified by:

reset in class ShadowLooper

idleIfPaused

public void idleIfPaused()

Description copied from class: ShadowLooper

Helper method to selectively call idle() only if LooperMode is PAUSED.

Intended for backwards compatibility, to avoid changing behavior for tests still using LEGACY LooperMode.

Specified by:

idleIfPaused in class ShadowLooper

idleConstantly

public void idleConstantly(boolean shouldIdleConstantly)

Specified by:

idleConstantly in class ShadowLooper

runToEndOfTasks

public void runToEndOfTasks()

Description copied from class: ShadowLooper

Causes all of the Runnables that have been scheduled to run while advancing the clock to the start time of the last scheduled Runnable.

Specified by:

runToEndOfTasks in class ShadowLooper

runToNextTask

public void runToNextTask()

Description copied from class: ShadowLooper

Causes the next Runnable(s) that have been scheduled to run while advancing the clock to its start time. If more than one Runnable is scheduled to run at this time then they will all be run.

Specified by:

runToNextTask in class ShadowLooper

runOneTask

public void runOneTask()

Description copied from class: ShadowLooper

Causes only one of the next Runnables that have been scheduled to run while advancing the clock to its start time. Only one Runnable will run even if more than one has been scheduled to run at the same time.

Specified by:

runOneTask in class ShadowLooper

post

public boolean post(Runnable runnable,
                    long delayMillis)

Description copied from class: ShadowLooper

Enqueue a task to be run later.

Specified by:

post in class ShadowLooper

Parameters:

runnable - the task to be run

delayMillis - how many milliseconds into the (virtual) future to run it

Returns:

true if the runnable is enqueued

See Also:

Handler.postDelayed(Runnable,long)

postAtFrontOfQueue

public boolean postAtFrontOfQueue(Runnable runnable)

Description copied from class: ShadowLooper

Enqueue a task to be run ahead of all other delayed tasks.

Specified by:

postAtFrontOfQueue in class ShadowLooper

Parameters:

runnable - the task to be run

Returns:

true if the runnable is enqueued

See Also:

Handler.postAtFrontOfQueue(Runnable)

runPaused

public void runPaused(Runnable runnable)

Description copied from class: ShadowLooper

Runs the current task with the looper paused.

When LooperMode is PAUSED, this will execute all pending tasks scheduled before the current time.

Specified by:

runPaused in class ShadowLooper

getNextScheduledTaskTime

public Duration getNextScheduledTaskTime()

Specified by:

getNextScheduledTaskTime in class ShadowLooper

Returns:

the scheduled time of the next posted task; Duration.ZERO if there is no currently scheduled task.

getLastScheduledTaskTime

public Duration getLastScheduledTaskTime()

Specified by:

getLastScheduledTaskTime in class ShadowLooper

Returns:

the scheduled time of the last posted task; Duration.ZERO 0 if there is no currently scheduled task.

resetLoopers

@Resetter
public static void resetLoopers()

prepareMainLooper

@Implementation
protected static void prepareMainLooper()

quit

@Implementation
protected void quit()

quitSafely

@Implementation(minSdk=18)
protected void quitSafely()

getScheduler

public org.robolectric.util.Scheduler getScheduler()

Description copied from class: ShadowLooper

Returns the Scheduler that is being used to manage the enqueued tasks. This scheduler is managed by the Looper’s associated queue.

Only supported for LooperMode.Mode.PAUSED.

Specified by:

getScheduler in class ShadowLooper

Returns:

the Scheduler that is being used to manage the enqueued tasks.