aboutsummaryrefslogtreecommitdiff
path: root/library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java
diff options
context:
space:
mode:
Diffstat (limited to 'library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java')
-rw-r--r--library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java13
1 files changed, 12 insertions, 1 deletions
diff --git a/library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java b/library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java
index dfe12406..eee17f50 100644
--- a/library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java
+++ b/library/src/main/java/com/bumptech/glide/request/animation/GlideAnimationFactory.java
@@ -1,7 +1,18 @@
package com.bumptech.glide.request.animation;
+/**
+ * A factory class that can produce different {@link com.bumptech.glide.request.animation.GlideAnimation}s based on the
+ * state of the request.
+ * @param <R> The type of resource that needs to be animated into the target.
+ */
public interface GlideAnimationFactory<R> {
- public GlideAnimation<R> build(boolean isFromMemoryCache, boolean isFirstImage);
+ /**
+ * Returns a new {@link com.bumptech.glide.request.animation.GlideAnimation}.
+ *
+ * @param isFromMemoryCache True if this will be an animation for a resource that was loaded from the memory cache.
+ * @param isFirstResource True if this is the first resource to be loaded into the target.
+ */
+ public GlideAnimation<R> build(boolean isFromMemoryCache, boolean isFirstResource);
}