-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #399 from storix/feature/gifdrawable-easysubclass
Simplify GIfDrawable subclassing
- Loading branch information
Showing
4 changed files
with
333 additions
and
251 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
253 changes: 3 additions & 250 deletions
253
android-gif-drawable/src/main/java/pl/droidsonroids/gif/GifDrawableBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,260 +1,13 @@ | ||
| package pl.droidsonroids.gif; | ||
|
|
||
| import android.content.ContentResolver; | ||
| import android.content.res.AssetFileDescriptor; | ||
| import android.content.res.AssetManager; | ||
| import android.content.res.Resources; | ||
| import android.net.Uri; | ||
| import android.support.annotation.IntRange; | ||
| import android.support.annotation.Nullable; | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileDescriptor; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.nio.ByteBuffer; | ||
| import java.util.concurrent.ScheduledThreadPoolExecutor; | ||
|
|
||
| import pl.droidsonroids.gif.annotations.Beta; | ||
|
|
||
| import static pl.droidsonroids.gif.InputSource.AssetFileDescriptorSource; | ||
| import static pl.droidsonroids.gif.InputSource.AssetSource; | ||
| import static pl.droidsonroids.gif.InputSource.ByteArraySource; | ||
| import static pl.droidsonroids.gif.InputSource.DirectByteBufferSource; | ||
| import static pl.droidsonroids.gif.InputSource.FileDescriptorSource; | ||
| import static pl.droidsonroids.gif.InputSource.FileSource; | ||
| import static pl.droidsonroids.gif.InputSource.InputStreamSource; | ||
| import static pl.droidsonroids.gif.InputSource.ResourcesSource; | ||
| import static pl.droidsonroids.gif.InputSource.UriSource; | ||
|
|
||
| /** | ||
| * Builder for {@link pl.droidsonroids.gif.GifDrawable} which can be used to construct new drawables | ||
| * by reusing old ones. | ||
| */ | ||
| public class GifDrawableBuilder { | ||
| private InputSource mInputSource; | ||
| private GifDrawable mOldDrawable; | ||
| private ScheduledThreadPoolExecutor mExecutor; | ||
| private boolean mIsRenderingTriggeredOnDraw = true; | ||
| private GifOptions mOptions = new GifOptions(); | ||
|
|
||
| /** | ||
| * Sample size controlling subsampling, see {@link GifOptions#setInSampleSize(int)} for more details. | ||
| * Note that this call will overwrite sample size set previously by {@link #options(GifOptions)} | ||
| * | ||
| * @param sampleSize the sample size | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder sampleSize(@IntRange(from = 1, to = Character.MAX_VALUE) final int sampleSize) { | ||
| mOptions.setInSampleSize(sampleSize); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Appropriate constructor wrapper. Must be preceded by on of {@code from()} calls. | ||
| * | ||
| * @return new drawable instance | ||
| * @throws IOException when creation fails | ||
| */ | ||
| public GifDrawable build() throws IOException { | ||
| if (mInputSource == null) { | ||
| throw new NullPointerException("Source is not set"); | ||
| } | ||
| return mInputSource.build(mOldDrawable, mExecutor, mIsRenderingTriggeredOnDraw, mOptions); | ||
| } | ||
|
|
||
| /** | ||
| * Sets drawable to be reused when creating new one. | ||
| * | ||
| * @param drawable drawable to be reused | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder with(GifDrawable drawable) { | ||
| mOldDrawable = drawable; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets thread pool size for rendering tasks. | ||
| * Warning: custom executor set by {@link #taskExecutor(java.util.concurrent.ScheduledThreadPoolExecutor)} | ||
| * will be overwritten after setting pool size | ||
| * | ||
| * @param threadPoolSize size of the pool | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder threadPoolSize(int threadPoolSize) { | ||
| mExecutor = new ScheduledThreadPoolExecutor(threadPoolSize); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets or resets executor for rendering tasks. | ||
| * Warning: value set by {@link #threadPoolSize(int)} will not be taken into account after setting executor | ||
| * | ||
| * @param executor executor to be used or null for default (each drawable instance has its own executor) | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder taskExecutor(ScheduledThreadPoolExecutor executor) { | ||
| mExecutor = executor; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * 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 | ||
| * {@link GifDrawable#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. | ||
| * | ||
| * @param isRenderingTriggeredOnDraw whether rendering of the next frame is scheduled after drawing (default) | ||
| * current one or just after it is rendered | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder renderingTriggeredOnDraw(boolean isRenderingTriggeredOnDraw) { | ||
| mIsRenderingTriggeredOnDraw = isRenderingTriggeredOnDraw; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Equivalent to {@link #renderingTriggeredOnDraw(boolean)}. This method does not follow naming convention | ||
| * and is preserved for backwards compatibility only. | ||
| * @param isRenderingTriggeredOnDraw whether rendering of the next frame is scheduled after drawing (default) | ||
| * current one or just after it is rendered | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder setRenderingTriggeredOnDraw(boolean isRenderingTriggeredOnDraw) { | ||
| return renderingTriggeredOnDraw(isRenderingTriggeredOnDraw); | ||
| } | ||
|
|
||
| /** | ||
| * 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 {@link GifTextureView#setOpaque(boolean)} | ||
| * for more information.<br> | ||
| * Currently it is used only by {@link GifTextureView}, not by {@link GifDrawable}. | ||
| * <p> | ||
| * Note that this call will overwrite sample size set previously by {@link #sampleSize(int)} | ||
| * | ||
| * @param options null-ok; options controlling parameters like subsampling and opacity | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| @Beta | ||
| public GifDrawableBuilder options(@Nullable GifOptions options) { | ||
| mOptions.setFrom(options); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(java.io.InputStream)} | ||
| * | ||
| * @param inputStream data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(InputStream inputStream) { | ||
| mInputSource = new InputStreamSource(inputStream); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(android.content.res.AssetFileDescriptor)} | ||
| * | ||
| * @param assetFileDescriptor data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(AssetFileDescriptor assetFileDescriptor) { | ||
| mInputSource = new AssetFileDescriptorSource(assetFileDescriptor); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(java.io.FileDescriptor)} | ||
| * | ||
| * @param fileDescriptor data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(FileDescriptor fileDescriptor) { | ||
| mInputSource = new FileDescriptorSource(fileDescriptor); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(android.content.res.AssetManager, java.lang.String)} | ||
| * | ||
| * @param assetManager assets source | ||
| * @param assetName asset file name | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(AssetManager assetManager, String assetName) { | ||
| mInputSource = new AssetSource(assetManager, assetName); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(android.content.ContentResolver, android.net.Uri)} | ||
| * | ||
| * @param uri data source | ||
| * @param contentResolver resolver used to query {@code uri} | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(ContentResolver contentResolver, Uri uri) { | ||
| mInputSource = new UriSource(contentResolver, uri); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(java.io.File)} | ||
| * | ||
| * @param file data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(File file) { | ||
| mInputSource = new FileSource(file); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(java.lang.String)} | ||
| * | ||
| * @param filePath data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(String filePath) { | ||
| mInputSource = new FileSource(filePath); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(byte[])} | ||
| * | ||
| * @param bytes data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(byte[] bytes) { | ||
| mInputSource = new ByteArraySource(bytes); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(java.nio.ByteBuffer)} | ||
| * | ||
| * @param byteBuffer data source | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(ByteBuffer byteBuffer) { | ||
| mInputSource = new DirectByteBufferSource(byteBuffer); | ||
| return this; | ||
| } | ||
| public class GifDrawableBuilder extends GifDrawableInit<GifDrawableBuilder>{ | ||
|
|
||
| /** | ||
| * Wrapper of {@link pl.droidsonroids.gif.GifDrawable#GifDrawable(android.content.res.Resources, int)} | ||
| * | ||
| * @param resources Resources to read from | ||
| * @param resourceId resource id (data source) | ||
| * @return this builder instance, to chain calls | ||
| */ | ||
| public GifDrawableBuilder from(Resources resources, int resourceId) { | ||
| mInputSource = new ResourcesSource(resources, resourceId); | ||
| @Override | ||
| protected GifDrawableBuilder self() { | ||
| return this; | ||
| } | ||
| } |
Oops, something went wrong.