com.bumptech.glide.load.engine.executor

Class GlideExecutor

java.lang.Object

com.bumptech.glide.load.engine.executor.GlideExecutor

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService

public final class GlideExecutor
extends java.lang.Object
implements java.util.concurrent.ExecutorService

A prioritized ThreadPoolExecutor for running jobs in Glide.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlideExecutor.UncaughtThrowableStrategy A strategy for handling unexpected and uncaught Throwables thrown by futures run on the pool.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
static int	calculateBestThreadCount() Determines the number of cores available on the device.
void	execute(java.lang.Runnable command)
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
static GlideExecutor	newAnimationExecutor() Returns a new cached thread pool that defaults to either one or two threads depending on the number of available cores to use when loading frames of animations.
static GlideExecutor	newAnimationExecutor(int threadCount, GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy) Returns a new cached thread pool with the given thread count and GlideExecutor.UncaughtThrowableStrategy to use when loading frames of animations.
static GlideExecutor	newDiskCacheExecutor() Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_DISK_CACHE_EXECUTOR_NAME thread name prefix, and the GlideExecutor.UncaughtThrowableStrategy.DEFAULT uncaught throwable strategy.
static GlideExecutor	newDiskCacheExecutor(GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy) Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_DISK_CACHE_EXECUTOR_NAME thread name prefix, and a custom GlideExecutor.UncaughtThrowableStrategy uncaught throwable strategy.
static GlideExecutor	newDiskCacheExecutor(int threadCount, java.lang.String name, GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy) Returns a new fixed thread pool with the given thread count, thread name prefix, and GlideExecutor.UncaughtThrowableStrategy.
static GlideExecutor	newSourceExecutor() Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_SOURCE_EXECUTOR_NAME thread name prefix, and the GlideExecutor.UncaughtThrowableStrategy.DEFAULT uncaught throwable strategy.
static GlideExecutor	newSourceExecutor(GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy) Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_SOURCE_EXECUTOR_NAME thread name prefix, and a custom GlideExecutor.UncaughtThrowableStrategy uncaught throwable strategy.
static GlideExecutor	newSourceExecutor(int threadCount, java.lang.String name, GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy) Returns a new fixed thread pool with the given thread count, thread name prefix, and GlideExecutor.UncaughtThrowableStrategy.
static GlideExecutor	newUnlimitedSourceExecutor() Returns a new unlimited thread pool with zero core thread count to make sure no threads are created by default, KEEP_ALIVE_TIME_MS keep alive time, the SOURCE_UNLIMITED_EXECUTOR_NAME thread name prefix, the GlideExecutor.UncaughtThrowableStrategy.DEFAULT uncaught throwable strategy, and the SynchronousQueue since using default unbounded blocking queue, for example, PriorityBlockingQueue effectively won't create more than corePoolSize threads.
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()
<T> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> task)
java.util.concurrent.Future<?>	submit(java.lang.Runnable task)
<T> java.util.concurrent.Future<T>	submit(java.lang.Runnable task, T result)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newDiskCacheExecutor

public static GlideExecutor newDiskCacheExecutor()

Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_DISK_CACHE_EXECUTOR_NAME thread name prefix, and the GlideExecutor.UncaughtThrowableStrategy.DEFAULT uncaught throwable strategy.

Disk cache executors do not allow network operations on their threads.

newDiskCacheExecutor

public static GlideExecutor newDiskCacheExecutor(GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy)

Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_DISK_CACHE_EXECUTOR_NAME thread name prefix, and a custom GlideExecutor.UncaughtThrowableStrategy uncaught throwable strategy.

Disk cache executors do not allow network operations on their threads.

Parameters:

uncaughtThrowableStrategy - The GlideExecutor.UncaughtThrowableStrategy to use to handle uncaught exceptions.

newDiskCacheExecutor

public static GlideExecutor newDiskCacheExecutor(int threadCount,
                                                 java.lang.String name,
                                                 GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy)

Returns a new fixed thread pool with the given thread count, thread name prefix, and GlideExecutor.UncaughtThrowableStrategy.

Disk cache executors do not allow network operations on their threads.

Parameters:

threadCount - The number of threads.

name - The prefix for each thread name.

uncaughtThrowableStrategy - The GlideExecutor.UncaughtThrowableStrategy to use to handle uncaught exceptions.

newSourceExecutor

public static GlideExecutor newSourceExecutor()

Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_SOURCE_EXECUTOR_NAME thread name prefix, and the GlideExecutor.UncaughtThrowableStrategy.DEFAULT uncaught throwable strategy.

Source executors allow network operations on their threads.

newSourceExecutor

public static GlideExecutor newSourceExecutor(GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy)

Returns a new fixed thread pool with the default thread count returned from calculateBestThreadCount(), the DEFAULT_SOURCE_EXECUTOR_NAME thread name prefix, and a custom GlideExecutor.UncaughtThrowableStrategy uncaught throwable strategy.

Source executors allow network operations on their threads.

Parameters:

uncaughtThrowableStrategy - The GlideExecutor.UncaughtThrowableStrategy to use to handle uncaught exceptions.

newSourceExecutor

public static GlideExecutor newSourceExecutor(int threadCount,
                                              java.lang.String name,
                                              GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy)

Returns a new fixed thread pool with the given thread count, thread name prefix, and GlideExecutor.UncaughtThrowableStrategy.

Source executors allow network operations on their threads.

Parameters:

threadCount - The number of threads.

name - The prefix for each thread name.

uncaughtThrowableStrategy - The GlideExecutor.UncaughtThrowableStrategy to use to handle uncaught exceptions.

newUnlimitedSourceExecutor

public static GlideExecutor newUnlimitedSourceExecutor()

Returns a new unlimited thread pool with zero core thread count to make sure no threads are created by default, KEEP_ALIVE_TIME_MS keep alive time, the SOURCE_UNLIMITED_EXECUTOR_NAME thread name prefix, the GlideExecutor.UncaughtThrowableStrategy.DEFAULT uncaught throwable strategy, and the SynchronousQueue since using default unbounded blocking queue, for example, PriorityBlockingQueue effectively won't create more than corePoolSize threads. See ThreadPoolExecutor documentation.

Source executors allow network operations on their threads.

newAnimationExecutor

public static GlideExecutor newAnimationExecutor()

Returns a new cached thread pool that defaults to either one or two threads depending on the number of available cores to use when loading frames of animations.

newAnimationExecutor

public static GlideExecutor newAnimationExecutor(int threadCount,
                                                 GlideExecutor.UncaughtThrowableStrategy uncaughtThrowableStrategy)

Returns a new cached thread pool with the given thread count and GlideExecutor.UncaughtThrowableStrategy to use when loading frames of animations.

execute

public void execute(@NonNull
                    java.lang.Runnable command)

Specified by:

execute in interface java.util.concurrent.Executor

submit

@NonNull
public java.util.concurrent.Future<?> submit(@NonNull
                                                      java.lang.Runnable task)

Specified by:

submit in interface java.util.concurrent.ExecutorService

invokeAll

@NonNull
public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(@NonNull
                                                                             java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                                                                      throws java.lang.InterruptedException

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAll

@NonNull
public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(@NonNull
                                                                             java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                                                                             long timeout,
                                                                             @NonNull
                                                                             java.util.concurrent.TimeUnit unit)
                                                                      throws java.lang.InterruptedException

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAny

@NonNull
public <T> T invokeAny(@NonNull
                                java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                         throws java.lang.InterruptedException,
                                java.util.concurrent.ExecutionException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

invokeAny

public <T> T invokeAny(@NonNull
                       java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                       long timeout,
                       @NonNull
                       java.util.concurrent.TimeUnit unit)
                throws java.lang.InterruptedException,
                       java.util.concurrent.ExecutionException,
                       java.util.concurrent.TimeoutException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

submit

@NonNull
public <T> java.util.concurrent.Future<T> submit(@NonNull
                                                          java.lang.Runnable task,
                                                          T result)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submit

public <T> java.util.concurrent.Future<T> submit(@NonNull
                                                 java.util.concurrent.Callable<T> task)

Specified by:

submit in interface java.util.concurrent.ExecutorService

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

shutdownNow

@NonNull
public java.util.List<java.lang.Runnable> shutdownNow()

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                                @NonNull
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

calculateBestThreadCount

public static int calculateBestThreadCount()

Determines the number of cores available on the device.