com.bumptech.glide

Class GlideBuilder

java.lang.Object

com.bumptech.glide.GlideBuilder

public final class GlideBuilder
extends Object

A builder class for setting default structural classes for Glide to use.

Constructor Summary

Constructors

Constructor and Description
GlideBuilder()

Method Summary

Modifier and Type	Method and Description
Glide	build(Context context)
GlideBuilder	setArrayPool(ArrayPool arrayPool) Sets the ArrayPool implementation to allow variable sized arrays to be stored and retrieved as needed.
GlideBuilder	setBitmapPool(BitmapPool bitmapPool) Sets the BitmapPool implementation to use to store and retrieve reused Bitmaps.
GlideBuilder	setConnectivityMonitorFactory(ConnectivityMonitorFactory factory) Sets the ConnectivityMonitorFactory to use to notify RequestManager of connectivity events.
GlideBuilder	setDecodeFormat(DecodeFormat decodeFormat) Deprecated. Use setDefaultRequestOptions(RequestOptions) instead.
GlideBuilder	setDefaultRequestOptions(RequestOptions requestOptions) Sets the default RequestOptions to use for all loads across the app.
<T> GlideBuilder	setDefaultTransitionOptions(Class<T> clazz, TransitionOptions<?,T> options) Sets the default TransitionOptions to use when starting a request that will load a resource with the given Class.
GlideBuilder	setDiskCache(DiskCache.Factory diskCacheFactory) Sets the DiskCache.Factory implementation to use to construct the DiskCache to use to store Resource data on disk.
GlideBuilder	setDiskCache(DiskCache diskCache) Deprecated. Creating a disk cache directory on the main thread causes strict mode violations, use setDiskCache(com.bumptech.glide.load.engine.cache.DiskCache.Factory) instead. Scheduled to be removed in Glide 4.0.
GlideBuilder	setDiskCacheExecutor(GlideExecutor service) Sets the ExecutorService implementation to use when retrieving Resources that are currently in cache.
GlideBuilder	setLogLevel(int logLevel) Sets a log level constant from those in Log to indicate the desired log verbosity.
GlideBuilder	setMemoryCache(MemoryCache memoryCache) Sets the MemoryCache implementation to store Resources that are not currently in use.
GlideBuilder	setMemorySizeCalculator(MemorySizeCalculator.Builder builder) Sets the MemorySizeCalculator to use to calculate maximum sizes for default MemoryCaches and/or default BitmapPools.
GlideBuilder	setMemorySizeCalculator(MemorySizeCalculator calculator) Sets the MemorySizeCalculator to use to calculate maximum sizes for default MemoryCaches and/or default BitmapPools.
GlideBuilder	setResizeExecutor(GlideExecutor service) Sets the ExecutorService implementation to use when retrieving Resources that are not already in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlideBuilder

public GlideBuilder()

Method Detail

setBitmapPool

public GlideBuilder setBitmapPool(BitmapPool bitmapPool)

Sets the BitmapPool implementation to use to store and retrieve reused Bitmaps.

Parameters:

bitmapPool - The pool to use.

Returns:

This builder.

setArrayPool

public GlideBuilder setArrayPool(ArrayPool arrayPool)

Sets the ArrayPool implementation to allow variable sized arrays to be stored and retrieved as needed.

Parameters:

arrayPool - The pool to use.

Returns:

This builder.

setMemoryCache

public GlideBuilder setMemoryCache(MemoryCache memoryCache)

Sets the MemoryCache implementation to store Resources that are not currently in use.

Parameters:

memoryCache - The cache to use.

Returns:

This builder.

setDiskCache

@Deprecated
public GlideBuilder setDiskCache(DiskCache diskCache)

Deprecated. Creating a disk cache directory on the main thread causes strict mode violations, use setDiskCache(com.bumptech.glide.load.engine.cache.DiskCache.Factory) instead. Scheduled to be removed in Glide 4.0.

Sets the DiskCache implementation to use to store Resource data and thumbnails.

Parameters:

diskCache - The disk cache to use.

Returns:

This builder.

setDiskCache

public GlideBuilder setDiskCache(DiskCache.Factory diskCacheFactory)

Sets the DiskCache.Factory implementation to use to construct the DiskCache to use to store Resource data on disk.

Parameters:

diskCacheFactory - The disk cache factory to use.

Returns:

This builder.

setResizeExecutor

public GlideBuilder setResizeExecutor(GlideExecutor service)

Sets the ExecutorService implementation to use when retrieving Resources that are not already in the cache.

Any implementation must order requests based on their Priority for thumbnail requests to work properly.

Parameters:

service - The ExecutorService to use.

Returns:

This builder.

See Also:

setDiskCacheExecutor(GlideExecutor), GlideExecutor

setDiskCacheExecutor

public GlideBuilder setDiskCacheExecutor(GlideExecutor service)

Sets the ExecutorService implementation to use when retrieving Resources that are currently in cache.

Any implementation must order requests based on their Priority for thumbnail requests to work properly.

Parameters:

service - The ExecutorService to use.

Returns:

This builder.

See Also:

setResizeExecutor(GlideExecutor), GlideExecutor

setDefaultRequestOptions

public GlideBuilder setDefaultRequestOptions(RequestOptions requestOptions)

Sets the default RequestOptions to use for all loads across the app.

Applying additional options with RequestBuilder.apply(RequestOptions) will override defaults set here.

Parameters:

requestOptions - The options to use by default.

Returns:

This builder.

setDefaultTransitionOptions

public <T> GlideBuilder setDefaultTransitionOptions(@NonNull
                                                    Class<T> clazz,
                                                    @Nullable
                                                    TransitionOptions<?,T> options)

Sets the default TransitionOptions to use when starting a request that will load a resource with the given Class.

It's preferable but not required for the requested resource class to match the resource class applied here as long as the resource class applied here is assignable from the requested resource class. For example you can set a default transition for Drawable and that default transition will be used if you subsequently start requests for specific Drawable types like GifDrawable or BitmapDrawable. Specific types are always preferred so if you register a default transition for both Drawable and BitmapDrawable and then start a request for BitmapDrawables, the transition you registered for BitmapDrawables will be used.

setDecodeFormat

@Deprecated
public GlideBuilder setDecodeFormat(DecodeFormat decodeFormat)

Deprecated. Use setDefaultRequestOptions(RequestOptions) instead.

Sets the DecodeFormat that will be the default format for all the default decoders that can change the Bitmap.Config of the Bitmaps they decode.

Decode format is always a suggestion, not a requirement. See DecodeFormat for more details.

Parameters:

decodeFormat - The format to use.

Returns:

This builder.

setMemorySizeCalculator

public GlideBuilder setMemorySizeCalculator(MemorySizeCalculator.Builder builder)

Sets the MemorySizeCalculator to use to calculate maximum sizes for default MemoryCaches and/or default BitmapPools.

Parameters:

builder - The builder to use (will not be modified).

Returns:

This builder.

See Also:

setMemorySizeCalculator(MemorySizeCalculator)

setMemorySizeCalculator

public GlideBuilder setMemorySizeCalculator(MemorySizeCalculator calculator)

Sets the MemorySizeCalculator to use to calculate maximum sizes for default MemoryCaches and/or default BitmapPools.

The given MemorySizeCalculator will not affect custom pools or caches provided via setBitmapPool(BitmapPool) or setMemoryCache(MemoryCache).

Parameters:

calculator - The calculator to use.

Returns:

This builder.

setConnectivityMonitorFactory

public GlideBuilder setConnectivityMonitorFactory(ConnectivityMonitorFactory factory)

Sets the ConnectivityMonitorFactory to use to notify RequestManager of connectivity events. If not set DefaultConnectivityMonitorFactory would be used.

Parameters:

factory - The factory to use

Returns:

This builder.

setLogLevel

public GlideBuilder setLogLevel(int logLevel)

Sets a log level constant from those in Log to indicate the desired log verbosity.

The level must be one of Log.VERBOSE, Log.DEBUG, Log.INFO, Log.WARN, or Log.ERROR.

Log.VERBOSE means one or more lines will be logged per request, including timing logs and failures. Log.DEBUG means at most one line will be logged per successful request, including timing logs, although many lines may be logged for failures including multiple complete stack traces. Log.INFO means failed loads will be logged including multiple complete stack traces, but successful loads will not be logged at all. Log.WARN means only summaries of failed loads will be logged. Log.ERROR means only exceptional cases will be logged.

All logs will be logged using the 'Glide' tag.

Many other debugging logs are available in individual classes. The log level supplied here only controls a small set of informative and well formatted logs. Users wishing to debug certain aspects of the library can look for individual TAG variables at the tops of classes and use adb shell setprop log.tag.TAG to enable or disable any relevant tags.

Parameters:

logLevel - The log level to use from Log.

Returns:

This builder.

build

public Glide build(Context context)