com.bumptech.glide
Class GifRequestBuilder<ModelType>

java.lang.Object
  com.bumptech.glide.GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>
      com.bumptech.glide.GifRequestBuilder<ModelType>

Type Parameters:

ModelType - The type of model that will be loaded into the target.

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

GifTypeRequest

public class GifRequestBuilder<ModelType>
extends GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

A class for creating a request to load an animated gif.

Warning - It is not safe to use this builder after calling into(), it may be pooled and reused.

Field Summary

Fields inherited from class com.bumptech.glide.GenericRequestBuilder

context, glide, lifecycle, modelClass, requestTracker, transcodeClass

Method Summary

GifRequestBuilder<ModelType>	animate(Animation animation) Deprecated.
GifRequestBuilder<ModelType>	animate(int animationId) Sets an animation to run on the wrapped target when an resource load finishes.
GifRequestBuilder<ModelType>	animate(ViewPropertyAnimation.Animator animator) Sets an animator to run a ViewPropertyAnimator on a view that the target may be wrapping when a resource load finishes.
GifRequestBuilder<ModelType>	cacheDecoder(ResourceDecoder<File,GifDrawable> cacheDecoder) Sets the ResourceDecoder to use to load the resource from the disk cache.
GifRequestBuilder<ModelType>	centerCrop() Transforms each frame of the GIF using CenterCrop.
GifRequestBuilder<ModelType>	clone() Returns a copy of this request builder with all of the options set so far on this builder.
GifRequestBuilder<ModelType>	crossFade() Applies a cross fade transformation that fades from the placeholder to the loaded Drawable.
GifRequestBuilder<ModelType>	crossFade(Animation animation, int duration) Deprecated.
GifRequestBuilder<ModelType>	crossFade(int duration) Applies a cross fade transformation that fades from the placeholder to the loaded Drawable.
GifRequestBuilder<ModelType>	crossFade(int animationId, int duration) Applies a cross fade transformation that des from the placeholder to the loaded Drawable.
GifRequestBuilder<ModelType>	decoder(ResourceDecoder<InputStream,GifDrawable> decoder) Sets the ResourceDecoder to use to load the resource from the original data.
GifRequestBuilder<ModelType>	diskCacheStrategy(DiskCacheStrategy strategy) Sets the DiskCacheStrategy to use for this load.
GifRequestBuilder<ModelType>	dontAnimate() Removes any existing animation set on the builder.
GifRequestBuilder<ModelType>	dontTransform() Removes the current Transformation.
GifRequestBuilder<ModelType>	encoder(ResourceEncoder<GifDrawable> encoder) Sets the Encoder to use to encode the original data directly to cache.
GifRequestBuilder<ModelType>	error(Drawable drawable) Sets a Drawable to display if a load fails.
GifRequestBuilder<ModelType>	error(int resourceId) Sets a resource to display if a load fails.
GifRequestBuilder<ModelType>	fallback(Drawable drawable) Sets an Drawable to display if the model provided to GenericRequestBuilder.load(Object) is null.
GifRequestBuilder<ModelType>	fallback(int resourceId) Sets a resource to display if the model provided to GenericRequestBuilder.load(Object) is null.
GifRequestBuilder<ModelType>	fitCenter() Transforms each frame of the GIF using FitCenter.
GifRequestBuilder<ModelType>	listener(RequestListener<? super ModelType,GifDrawable> requestListener) Sets a RequestBuilder listener to monitor the resource load.
GifRequestBuilder<ModelType>	load(ModelType model) Sets the specific model to load data for.
GifRequestBuilder<ModelType>	override(int width, int height) Overrides the Target's width and height with the given values.
GifRequestBuilder<ModelType>	placeholder(Drawable drawable) Sets an Drawable to display while a resource is loading.
GifRequestBuilder<ModelType>	placeholder(int resourceId) Sets an Android resource id for a Drawable resourceto display while a resource is loading.
GifRequestBuilder<ModelType>	priority(Priority priority) Sets the priority for this load.
GifRequestBuilder<ModelType>	signature(Key signature) Sets some additional data to be mixed in to the memory and disk cache keys allowing the caller more control over when cached data is invalidated.
GifRequestBuilder<ModelType>	sizeMultiplier(float sizeMultiplier) Applies a multiplier to the Target's size before loading the resource.
GifRequestBuilder<ModelType>	skipMemoryCache(boolean skip) Allows the loaded resource to skip the memory cache.
GifRequestBuilder<ModelType>	sourceEncoder(Encoder<InputStream> sourceEncoder) Sets the source encoder to use to encode the data retrieved by this request directly into cache.
GifRequestBuilder<ModelType>	thumbnail(float sizeMultiplier) Loads a resource in an identical manner to this request except with the dimensions of the target multiplied by the given size multiplier.
GifRequestBuilder<ModelType>	thumbnail(GenericRequestBuilder<?,?,?,GifDrawable> thumbnailRequest) Loads and displays the resource retrieved by the given thumbnail request if it finishes before this request.
GifRequestBuilder<ModelType>	thumbnail(GifRequestBuilder<?> thumbnailRequest) Loads and displays the GIF retrieved by the given thumbnail request if it finishes before this request.
GifRequestBuilder<ModelType>	transcoder(ResourceTranscoder<GifDrawable,GifDrawable> transcoder) Sets the ResourceTranscoder to use for this load.
GifRequestBuilder<ModelType>	transform(Transformation<GifDrawable>... transformations) Transform resources with the given Transformations.
GifRequestBuilder<ModelType>	transformFrame(BitmapTransformation... bitmapTransformations) Transforms each frame of the GIF using the given transformations.
GifRequestBuilder<ModelType>	transformFrame(Transformation<Bitmap>... bitmapTransformations) Transforms each frame of the GIF using the given transformations.

Methods inherited from class com.bumptech.glide.GenericRequestBuilder

into, into, into, preload, preload

Methods inherited from class java.lang.Object

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

Method Detail

thumbnail

public GifRequestBuilder<ModelType> thumbnail(GenericRequestBuilder<?,?,?,GifDrawable> thumbnailRequest)

Loads and displays the resource retrieved by the given thumbnail request if it finishes before this request. Best used for loading thumbnail resources that are smaller and will be loaded more quickly than the full size resource. There are no guarantees about the order in which the requests will actually finish. However, if the thumb request completes after the full request, the thumb resource will never replace the full resource.

Overrides:

thumbnail in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

thumbnailRequest - The request to use to load the thumbnail.

Returns:

This request builder.

See Also:

Recursive calls to thumbnail are supported.

thumbnail

public GifRequestBuilder<ModelType> thumbnail(GifRequestBuilder<?> thumbnailRequest)

Loads and displays the GIF retrieved by the given thumbnail request if it finishes before this request. Best used for loading thumbnail GIFs that are smaller and will be loaded more quickly than the fullsize GIF. There are no guarantees about the order in which the requests will actually finish. However, if the thumb request completes after the full request, the thumb GIF will never replace the full image.

Parameters:

thumbnailRequest - The request to use to load the thumbnail.

Returns:

This builder object.

See Also:

Note - Any options on the main request will not be passed on to the thumbnail request. For example, if you want an animation to occur when either the full GIF loads or the thumbnail loads, you need to call {@link #animate(int)} on both the thumb and the full request. For a simpler thumbnail option where these options are applied to the humbnail as well, see {@link #thumbnail(float)}.

Only the thumbnail call on the main request will be obeyed, recursive calls to this method are ignored.

thumbnail

public GifRequestBuilder<ModelType> thumbnail(float sizeMultiplier)

Loads a resource in an identical manner to this request except with the dimensions of the target multiplied by the given size multiplier. If the thumbnail load completes before the fullsize load, the thumbnail will be shown. If the thumbnail load completes afer the fullsize load, the thumbnail will not be shown.

Note - The thumbnail resource will be smaller than the size requested so the target (or ImageView) must be able to scale the thumbnail appropriately. See ImageView.ScaleType.

Almost all options will be copied from the original load, including the ModelLoader, ResourceDecoder, and Transformations. However, GenericRequestBuilder.placeholder(int) and GenericRequestBuilder.error(int), and GenericRequestBuilder.listener(RequestListener) will only be used on the fullsize load and will not be copied for the thumbnail load.

Recursive calls to thumbnail are supported.

Overrides:

thumbnail in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

sizeMultiplier - The multiplier to apply to the Target's dimensions when loading the thumbnail.

Returns:

This request builder.

sizeMultiplier

public GifRequestBuilder<ModelType> sizeMultiplier(float sizeMultiplier)

Applies a multiplier to the Target's size before loading the resource. Useful for loading thumbnails or trying to avoid loading huge resources (particularly Bitmaps on devices with overly dense screens.

Overrides:

sizeMultiplier in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

sizeMultiplier - The multiplier to apply to the Target's dimensions when loading the resource.

Returns:

This request builder.

decoder

public GifRequestBuilder<ModelType> decoder(ResourceDecoder<InputStream,GifDrawable> decoder)

Sets the ResourceDecoder to use to load the resource from the original data. By default, this decoder will only be used if the final transformed resource is not in the disk cache.

Overrides:

decoder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

decoder - The ResourceDecoder to use to decode the resource.

Returns:

This request builder.

See Also:

GenericRequestBuilder.cacheDecoder(com.bumptech.glide.load.ResourceDecoder), DiskCacheStrategy

cacheDecoder

public GifRequestBuilder<ModelType> cacheDecoder(ResourceDecoder<File,GifDrawable> cacheDecoder)

Sets the ResourceDecoder to use to load the resource from the disk cache. By default, this decoder will only be used if the final transformed resource is already in the disk cache.

Overrides:

cacheDecoder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

cacheDecoder - The decoder to use.

Returns:

This request builder.

See Also:

GenericRequestBuilder.decoder(com.bumptech.glide.load.ResourceDecoder), DiskCacheStrategy

encoder

public GifRequestBuilder<ModelType> encoder(ResourceEncoder<GifDrawable> encoder)

Sets the Encoder to use to encode the original data directly to cache. Will only be used if the original data is not already in cache and if the DiskCacheStrategy is set to DiskCacheStrategy.SOURCE or DiskCacheStrategy.ALL.

Overrides:

encoder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

encoder - The encoder to use.

Returns:

This request builder.

See Also:

GenericRequestBuilder.sourceEncoder(com.bumptech.glide.load.Encoder), DiskCacheStrategy

priority

public GifRequestBuilder<ModelType> priority(Priority priority)

Sets the priority for this load.

Overrides:

priority in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

priority - A priority.

Returns:

This request builder.

centerCrop

public GifRequestBuilder<ModelType> centerCrop()

Transforms each frame of the GIF using CenterCrop.

Returns:

This request builder.

See Also:

fitCenter(), transformFrame(com.bumptech.glide.load.resource.bitmap.BitmapTransformation...), transformFrame(com.bumptech.glide.load.Transformation[]), transform(com.bumptech.glide.load.Transformation[])

fitCenter

public GifRequestBuilder<ModelType> fitCenter()

Transforms each frame of the GIF using FitCenter.

Returns:

This request builder..

See Also:

centerCrop(), transformFrame(com.bumptech.glide.load.resource.bitmap.BitmapTransformation...), transformFrame(com.bumptech.glide.load.Transformation[]), transform(com.bumptech.glide.load.Transformation[])

transformFrame

public GifRequestBuilder<ModelType> transformFrame(BitmapTransformation... bitmapTransformations)

Transforms each frame of the GIF using the given transformations.

Parameters:

bitmapTransformations - The transformations to apply in order to each frame.

Returns:

This request builder.

See Also:

centerCrop(), fitCenter(), transformFrame(com.bumptech.glide.load.Transformation[]), transform(com.bumptech.glide.load.Transformation[])

transformFrame

public GifRequestBuilder<ModelType> transformFrame(Transformation<Bitmap>... bitmapTransformations)

Transforms each frame of the GIF using the given transformations.

Parameters:

bitmapTransformations - The transformations to apply in order to each frame.

Returns:

This request builder.

See Also:

fitCenter(), centerCrop(), transformFrame(com.bumptech.glide.load.resource.bitmap.BitmapTransformation...), transform(com.bumptech.glide.load.Transformation[])

transform

public GifRequestBuilder<ModelType> transform(Transformation<GifDrawable>... transformations)

Transform resources with the given Transformations. Replaces any existing transformation or transformations.

Overrides:

transform in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

transformations - the transformations to apply in order.

Returns:

This request builder.

See Also:

fitCenter(), centerCrop(), transformFrame(com.bumptech.glide.load.resource.bitmap.BitmapTransformation...), transformFrame(com.bumptech.glide.load.Transformation[])

transcoder

public GifRequestBuilder<ModelType> transcoder(ResourceTranscoder<GifDrawable,GifDrawable> transcoder)

Sets the ResourceTranscoder to use for this load.

Overrides:

transcoder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

transcoder - The transcoder to use.

Returns:

This request builder.

See Also:

UnitTranscoder, GlideBitmapDrawableTranscoder, GifBitmapWrapperDrawableTranscoder

crossFade

public GifRequestBuilder<ModelType> crossFade()

Applies a cross fade transformation that fades from the placeholder to the loaded Drawable. If no placeholder is set, the Drawable will instead simply fade in.

Returns:

This request builder.

See Also:

crossFade(int), crossFade(int, int)

crossFade

public GifRequestBuilder<ModelType> crossFade(int duration)

Applies a cross fade transformation that fades from the placeholder to the loaded Drawable. If no placeholder is set the Drawable will instead simply fade in.

Parameters:

duration - The duration of the cross fade and initial fade in.

Returns:

This request builder.

See Also:

crossFade(), crossFade(int, int)

crossFade

@Deprecated
public GifRequestBuilder<ModelType> crossFade(Animation animation,
                                                         int duration)

Deprecated.

Applies a cross fade transformation that des from the placeholder to the loaded Drawable. If no placeholder is set, the Drawable will instead be animated in using the given Animation.

Parameters:

animation - The Animation to use if no placeholder is set.

duration - The duration of the cross fade animation.

Returns:

This request builder.

See Also:

crossFade(), crossFade(int), crossFade(int, int)

crossFade

public GifRequestBuilder<ModelType> crossFade(int animationId,
                                              int duration)

Applies a cross fade transformation that des from the placeholder to the loaded Drawable. If no placeholder is set, the Drawable will instead be animated in using the Animation loaded from the given animation id.

Parameters:

animationId - The id of the Animation to use if no placeholder is set.

duration - The duration of the cross fade animation.

Returns:

This request builder.

See Also:

crossFade(), crossFade(int)

dontAnimate

public GifRequestBuilder<ModelType> dontAnimate()

Removes any existing animation set on the builder. Will be overridden by subsequent calls that set an animation.

Overrides:

dontAnimate in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Returns:

This request builder.

animate

public GifRequestBuilder<ModelType> animate(int animationId)

Sets an animation to run on the wrapped target when an resource load finishes. Will only be run if the resource was loaded asynchronously (ie was not in the memory cache)

Overrides:

animate in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

animationId - The resource id of the animation to run

Returns:

This request builder.

animate

@Deprecated
public GifRequestBuilder<ModelType> animate(Animation animation)

Deprecated.

Sets an animation to run on the wrapped target when a resource load finishes. Will only be run if the resource was loaded asynchronously (ie was not in the memory cache)

Overrides:

animate in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

animation - The animation to run

Returns:

This request builder.

See Also:

GenericRequestBuilder.animate(int), GenericRequestBuilder.animate(com.bumptech.glide.request.animation.ViewPropertyAnimation.Animator)

animate

public GifRequestBuilder<ModelType> animate(ViewPropertyAnimation.Animator animator)

Sets an animator to run a ViewPropertyAnimator on a view that the target may be wrapping when a resource load finishes. Will only be run if the load was loaded asynchronously (ie was not in the memory cache).

Overrides:

animate in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

animator - The ViewPropertyAnimation.Animator to run.

Returns:

This request builder.

placeholder

public GifRequestBuilder<ModelType> placeholder(int resourceId)

Sets an Android resource id for a Drawable resourceto display while a resource is loading.

Overrides:

placeholder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

resourceId - The id of the resource to use as a placeholder

Returns:

This request builder.

placeholder

public GifRequestBuilder<ModelType> placeholder(Drawable drawable)

Sets an Drawable to display while a resource is loading.

Overrides:

placeholder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

drawable - The drawable to display as a placeholder.

Returns:

This request builder.

fallback

public GifRequestBuilder<ModelType> fallback(Drawable drawable)

Description copied from class: GenericRequestBuilder

Sets an Drawable to display if the model provided to GenericRequestBuilder.load(Object) is null.

If a fallback is not set, null models will cause the error drawable to be displayed. If the error drawable is not set, the placeholder will be displayed.

Overrides:

fallback in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

drawable - The drawable to display as a placeholder.

Returns:

This request builder.

See Also:

GenericRequestBuilder.placeholder(Drawable), GenericRequestBuilder.placeholder(int)

fallback

public GifRequestBuilder<ModelType> fallback(int resourceId)

Description copied from class: GenericRequestBuilder

Sets a resource to display if the model provided to GenericRequestBuilder.load(Object) is null.

If a fallback is not set, null models will cause the error drawable to be displayed. If the error drawable is not set, the placeholder will be displayed.

Overrides:

fallback in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

resourceId - The id of the resource to use as a fallback.

Returns:

This request builder.

See Also:

GenericRequestBuilder.placeholder(Drawable), GenericRequestBuilder.placeholder(int)

error

public GifRequestBuilder<ModelType> error(int resourceId)

Sets a resource to display if a load fails.

Overrides:

error in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

resourceId - The id of the resource to use as a placeholder.

Returns:

This request builder.

error

public GifRequestBuilder<ModelType> error(Drawable drawable)

Sets a Drawable to display if a load fails.

Overrides:

error in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

drawable - The drawable to display.

Returns:

This request builder.

listener

public GifRequestBuilder<ModelType> listener(RequestListener<? super ModelType,GifDrawable> requestListener)

Sets a RequestBuilder listener to monitor the resource load. It's best to create a single instance of an exception handler per type of request (usually activity/fragment) rather than pass one in per request to avoid some redundant object allocation.

Overrides:

listener in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

requestListener - The request listener to use.

Returns:

This request builder.

skipMemoryCache

public GifRequestBuilder<ModelType> skipMemoryCache(boolean skip)

Allows the loaded resource to skip the memory cache.

Note - this is not a guarantee. If a request is already pending for this resource and that request is not also skipping the memory cache, the resource will be cached in memory.

Overrides:

skipMemoryCache in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

skip - True to allow the resource to skip the memory cache.

Returns:

This request builder.

diskCacheStrategy

public GifRequestBuilder<ModelType> diskCacheStrategy(DiskCacheStrategy strategy)

Sets the DiskCacheStrategy to use for this load. Defaults to DiskCacheStrategy.RESULT.

For most applications DiskCacheStrategy.RESULT is ideal. Applications that use the same resource multiple times in multiple sizes and are willing to trade off some speed and disk space in return for lower bandwidth usage may want to consider using DiskCacheStrategy.SOURCE or DiskCacheStrategy.RESULT. Any download only operations should typically use DiskCacheStrategy.SOURCE.

Overrides:

diskCacheStrategy in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

strategy - The strategy to use.

Returns:

This request builder.

override

public GifRequestBuilder<ModelType> override(int width,
                                             int height)

Overrides the Target's width and height with the given values. This is useful almost exclusively for thumbnails, and should only be used when you both need a very specific sized image and when it is impossible or impractical to return that size from Target.getSize(com.bumptech.glide.request.target.SizeReadyCallback).

Overrides:

override in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

width - The width in pixels to use to load the resource.

height - The height in pixels to use to load the resource.

Returns:

This request builder.

sourceEncoder

public GifRequestBuilder<ModelType> sourceEncoder(Encoder<InputStream> sourceEncoder)

Sets the source encoder to use to encode the data retrieved by this request directly into cache. The returned resource will then be decoded from the cached data.

Overrides:

sourceEncoder in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

sourceEncoder - The encoder to use.

Returns:

This request builder.

See Also:

DiskCacheStrategy

dontTransform

public GifRequestBuilder<ModelType> dontTransform()

Removes the current Transformation.

Overrides:

dontTransform in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Returns:

This request builder.

signature

public GifRequestBuilder<ModelType> signature(Key signature)

Description copied from class: GenericRequestBuilder

Sets some additional data to be mixed in to the memory and disk cache keys allowing the caller more control over when cached data is invalidated.

Note - The signature does not replace the cache key, it is purely additive.

Overrides:

signature in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

signature - A unique non-null Key representing the current state of the model that will be mixed in to the cache key.

Returns:

This request builder.

See Also:

StringSignature

load

public GifRequestBuilder<ModelType> load(ModelType model)

Description copied from class: GenericRequestBuilder

Sets the specific model to load data for.

This method must be called at least once before GenericRequestBuilder.into(com.bumptech.glide.request.target.Target) is called.

Overrides:

load in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>

Parameters:

model - The model to load data for, or null.

Returns:

This request builder.

clone

public GifRequestBuilder<ModelType> clone()

Description copied from class: GenericRequestBuilder

Returns a copy of this request builder with all of the options set so far on this builder.

This method returns a "deep" copy in that all non-immutable arguments are copied such that changes to one builder will not affect the other builder. However, in addition to immutable arguments, the current model is not copied copied so changes to the model will affect both builders.

Overrides:

clone in class GenericRequestBuilder<ModelType,InputStream,GifDrawable,GifDrawable>