com.uber.autodispose.android

Class AutoDisposeAndroidPlugins

java.lang.Object

com.uber.autodispose.android.AutoDisposeAndroidPlugins

public final class AutoDisposeAndroidPlugins
extends java.lang.Object

Utility class to inject handlers to certain standard AutoDispose Android operations.

Method Summary

Modifier and Type	Method and Description
static boolean	isLockdown() Returns true if the plugins were locked down.
static void	lockdown() Prevents changing the plugins from then on.
static boolean	onCheckMainThread(BooleanSupplier defaultChecker) Returns true if called on the main thread, false if not.
static void	reset() Removes all handlers and resets to default behavior.
static void	setOnCheckMainThread(BooleanSupplier mainThreadChecker) Sets the preferred main thread checker.

Methods inherited from class java.lang.Object

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

Method Detail

lockdown

public static void lockdown()

Prevents changing the plugins from then on.

This allows container-like environments to prevent client messing with plugins.

isLockdown

public static boolean isLockdown()

Returns true if the plugins were locked down.

Returns:

true if the plugins were locked down

setOnCheckMainThread

public static void setOnCheckMainThread(BooleanSupplier mainThreadChecker)

Sets the preferred main thread checker. If not null, the mainThreadChecker will be preferred in all main thread checks in onCheckMainThread(BooleanSupplier) calls. This can be useful for JVM testing environments, where standard Android Looper APIs cannot be stubbed and thus should be overridden with a custom check.

This is a reset-able API, which means you can pass null as the parameter value to reset it. Alternatively, you can call reset().

Parameters:

mainThreadChecker - a BooleanSupplier to call to check if current execution is on the main thread. Should return true if it is on the main thread or false if not.

onCheckMainThread

public static boolean onCheckMainThread(BooleanSupplier defaultChecker)

Returns true if called on the main thread, false if not. This will prefer a set checker via setOnCheckMainThread(BooleanSupplier) if one is present, otherwise it will use defaultChecker.

Parameters:

defaultChecker - the default checker to fall back to if there is no main thread checker set.

Returns:

true if called on the main thread, false if not.

reset

public static void reset()

Removes all handlers and resets to default behavior.