pl.droidsonroids.gif

Class GifDrawableBuilder

java.lang.Object

pl.droidsonroids.gif.GifDrawableBuilder

public class GifDrawableBuilder
extends Object

Builder for GifDrawable which can be used to construct new drawables by reusing old ones.

Constructor Summary

Constructors

Constructor and Description
GifDrawableBuilder()

Method Summary

Modifier and Type	Method and Description
GifDrawable	build() Appropriate constructor wrapper.
GifDrawableBuilder	from(AssetFileDescriptor assetFileDescriptor) Wrapper of GifDrawable.GifDrawable(android.content.res.AssetFileDescriptor)
GifDrawableBuilder	from(AssetManager assetManager, String assetName) Wrapper of GifDrawable.GifDrawable(android.content.res.AssetManager, java.lang.String)
GifDrawableBuilder	from(byte[] bytes) Wrapper of GifDrawable.GifDrawable(byte[])
GifDrawableBuilder	from(ByteBuffer byteBuffer) Wrapper of GifDrawable.GifDrawable(java.nio.ByteBuffer)
GifDrawableBuilder	from(ContentResolver contentResolver, Uri uri) Wrapper of GifDrawable.GifDrawable(android.content.ContentResolver, android.net.Uri)
GifDrawableBuilder	from(File file) Wrapper of GifDrawable.GifDrawable(java.io.File)
GifDrawableBuilder	from(FileDescriptor fileDescriptor) Wrapper of GifDrawable.GifDrawable(java.io.FileDescriptor)
GifDrawableBuilder	from(InputStream inputStream) Wrapper of GifDrawable.GifDrawable(java.io.InputStream)
GifDrawableBuilder	from(Resources resources, int resourceId) Wrapper of GifDrawable.GifDrawable(android.content.res.Resources, int)
GifDrawableBuilder	from(String filePath) Wrapper of GifDrawable.GifDrawable(java.lang.String)
GifDrawableBuilder	options(GifOptions options) Indicates whether the content of this source is opaque.
GifDrawableBuilder	renderingTriggeredOnDraw(boolean isRenderingTriggeredOnDraw) Sets whether rendering of the next frame is scheduled after drawing current one (so animation will be paused if drawing does not happen) or just after rendering frame (no matter if it is drawn or not).
GifDrawableBuilder	sampleSize(int sampleSize) Sample size controlling subsampling, see GifOptions.setInSampleSize(int) for more details.
GifDrawableBuilder	setRenderingTriggeredOnDraw(boolean isRenderingTriggeredOnDraw) Equivalent to renderingTriggeredOnDraw(boolean).
GifDrawableBuilder	taskExecutor(ScheduledThreadPoolExecutor executor) Sets or resets executor for rendering tasks.
GifDrawableBuilder	threadPoolSize(int threadPoolSize) Sets thread pool size for rendering tasks.
GifDrawableBuilder	with(GifDrawable drawable) Sets drawable to be reused when creating new one.

Methods inherited from class java.lang.Object

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

Constructor Detail

GifDrawableBuilder

public GifDrawableBuilder()

Method Detail

sampleSize

public GifDrawableBuilder sampleSize(int sampleSize)

Sample size controlling subsampling, see GifOptions.setInSampleSize(int) for more details. Note that this call will overwrite sample size set previously by options(GifOptions)

Parameters:

sampleSize - the sample size

Returns:

this builder instance, to chain calls

build

public GifDrawable build()
                  throws IOException

Appropriate constructor wrapper. Must be preceded by on of from() calls.

Returns:

new drawable instance

Throws:

IOException - when creation fails

with

public GifDrawableBuilder with(GifDrawable drawable)

Sets drawable to be reused when creating new one.

Parameters:

drawable - drawable to be reused

Returns:

this builder instance, to chain calls

threadPoolSize

public GifDrawableBuilder threadPoolSize(int threadPoolSize)

Sets thread pool size for rendering tasks. Warning: custom executor set by taskExecutor(java.util.concurrent.ScheduledThreadPoolExecutor) will be overwritten after setting pool size

Parameters:

threadPoolSize - size of the pool

Returns:

this builder instance, to chain calls

taskExecutor

public GifDrawableBuilder taskExecutor(ScheduledThreadPoolExecutor executor)

Sets or resets executor for rendering tasks. Warning: value set by threadPoolSize(int) will not be taken into account after setting executor

Parameters:

executor - executor to be used or null for default (each drawable instance has its own executor)

Returns:

this builder instance, to chain calls

renderingTriggeredOnDraw

public GifDrawableBuilder renderingTriggeredOnDraw(boolean isRenderingTriggeredOnDraw)

Sets whether rendering of the next frame is scheduled after drawing current one (so animation will be paused if drawing does not happen) or just after rendering frame (no matter if it is drawn or not). However animation will never run if drawable is set to not visible. See Drawable.isVisible() for more information about drawable visibility. By default this option is enabled. Note that drawing does not happen if view containing drawable is obscured. Disabling this option will prevent that however battery draining will be higher.

Parameters:

isRenderingTriggeredOnDraw - whether rendering of the next frame is scheduled after drawing (default) current one or just after it is rendered

Returns:

this builder instance, to chain calls

setRenderingTriggeredOnDraw

public GifDrawableBuilder setRenderingTriggeredOnDraw(boolean isRenderingTriggeredOnDraw)

Equivalent to renderingTriggeredOnDraw(boolean). This method does not follow naming convention and is preserved for backwards compatibility only.

Parameters:

isRenderingTriggeredOnDraw - whether rendering of the next frame is scheduled after drawing (default) current one or just after it is rendered

Returns:

this builder instance, to chain calls

options

@Beta
public GifDrawableBuilder options(@Nullable
                                        GifOptions options)

Indicates whether the content of this source is opaque. GIF that is known to be opaque can take a faster drawing case than non-opaque one. See GifTextureView.setOpaque(boolean) for more information.
Currently it is used only by GifTextureView, not by GifDrawable.

Note that this call will overwrite sample size set previously by sampleSize(int)

Parameters:

options - null-ok; options controlling parameters like subsampling and opacity

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(InputStream inputStream)

Wrapper of GifDrawable.GifDrawable(java.io.InputStream)

Parameters:

inputStream - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(AssetFileDescriptor assetFileDescriptor)

Wrapper of GifDrawable.GifDrawable(android.content.res.AssetFileDescriptor)

Parameters:

assetFileDescriptor - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(FileDescriptor fileDescriptor)

Wrapper of GifDrawable.GifDrawable(java.io.FileDescriptor)

Parameters:

fileDescriptor - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(AssetManager assetManager,
                               String assetName)

Wrapper of GifDrawable.GifDrawable(android.content.res.AssetManager, java.lang.String)

Parameters:

assetManager - assets source

assetName - asset file name

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(ContentResolver contentResolver,
                               Uri uri)

Wrapper of GifDrawable.GifDrawable(android.content.ContentResolver, android.net.Uri)

Parameters:

uri - data source

contentResolver - resolver used to query uri

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(File file)

Wrapper of GifDrawable.GifDrawable(java.io.File)

Parameters:

file - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(String filePath)

Wrapper of GifDrawable.GifDrawable(java.lang.String)

Parameters:

filePath - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(byte[] bytes)

Wrapper of GifDrawable.GifDrawable(byte[])

Parameters:

bytes - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(ByteBuffer byteBuffer)

Wrapper of GifDrawable.GifDrawable(java.nio.ByteBuffer)

Parameters:

byteBuffer - data source

Returns:

this builder instance, to chain calls

from

public GifDrawableBuilder from(Resources resources,
                               int resourceId)

Wrapper of GifDrawable.GifDrawable(android.content.res.Resources, int)

Parameters:

resources - Resources to read from

resourceId - resource id (data source)

Returns:

this builder instance, to chain calls