RequestFutureTarget (glide API)

java.lang.Object
- com.bumptech.glide.request.RequestFutureTarget<R>

Type Parameters:: R - The type of the resource that will be loaded.

All Implemented Interfaces:: LifecycleListener, FutureTarget<R>, RequestListener<R>, Target<R>, Runnable, Future<R>

public class RequestFutureTarget<R>
extends Object
implements FutureTarget<R>, RequestListener<R>, Runnable

A Future implementation for Glide that can be used to load resources in a blocking manner on background threads.

Note - Unlike most targets, RequestFutureTargets can be used once and only once. Attempting to reuse a RequestFutureTarget will probably result in undesirable behavior or exceptions. Instead of reusing objects of this class, the pattern should be:

     
      FutureTarget<File> target = null;
      RequestManager requestManager = Glide.with(context);
      try {
        target = requestManager
           .downloadOnly()
           .load(model)
           .submit();
        File downloadedFile = target.get();
        // ... do something with the file (usually throws IOException)
      } catch (ExecutionException | InterruptedException | IOException e) {
        // ... bug reporting or recovery
      } finally {
        // make sure to cancel pending operations and free resources
        if (target != null) {
          target.cancel(true); // mayInterruptIfRunning
        }
      }

The cancel(boolean) call will cancel pending operations and make sure that any resources used are recycled.

Field Summary
- Fields inherited from interface com.bumptech.glide.request.target.Target
  SIZE_ORIGINAL

Constructor Summary

Constructors
Constructor and Description

RequestFutureTarget(Handler mainHandler, int width, int height)
Constructor for a RequestFutureTarget.

Constructors
Constructor and Description
`RequestFutureTarget(Handler mainHandler, int width, int height)` Constructor for a RequestFutureTarget.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel(boolean mayInterruptIfRunning)`
`R`	`get()`
`R`	`get(long time, TimeUnit timeUnit)`
`Request`	`getRequest()` Retrieves the current request for this target, should not be called outside of Glide.
`void`	`getSize(SizeReadyCallback cb)` A callback that should never be invoked directly.
`boolean`	`isCancelled()`
`boolean`	`isDone()`
`void`	`onDestroy()` Callback for when `Fragment.onDestroy()`} or `Activity.onDestroy()` is called.
`void`	`onLoadCleared(Drawable placeholder)` A callback that should never be invoked directly.
`void`	`onLoadFailed(Drawable errorDrawable)` A callback that should never be invoked directly.
`boolean`	`onLoadFailed(GlideException e, Object model, Target<R> target, boolean isFirstResource)` Called when an exception occurs during a load, immediately before `Target.onLoadFailed(Drawable)`.
`void`	`onLoadStarted(Drawable placeholder)` A callback that should never be invoked directly.
`boolean`	`onResourceReady(R resource, Object model, Target<R> target, DataSource dataSource, boolean isFirstResource)` Called when a load completes successfully, immediately before `Target.onResourceReady(Object, com.bumptech.glide.request.transition.Transition)`.
`void`	`onResourceReady(R resource, Transition<? super R> transition)` A callback that should never be invoked directly.
`void`	`onStart()` Callback for when `Fragment.onStart()`} or `Activity.onStart()` is called.
`void`	`onStop()` Callback for when `Fragment.onStop()`} or `Activity.onStop()`} is called.
`void`	`removeCallback(SizeReadyCallback cb)` Removes the given callback from the pending set if it's still retained.
`void`	`run()` A callback that should never be invoked directly.
`void`	`setRequest(Request request)` Sets the current request for this target to retain, should not be called outside of Glide.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RequestFutureTarget
```
public RequestFutureTarget(Handler mainHandler,
                           int width,
                           int height)
```
    Constructor for a RequestFutureTarget. Should not be used directly.
- Method Detail
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    Specified by:
    
    cancel in interface Future<R>
  - isCancelled
```
public boolean isCancelled()
```
    Specified by:
    
    isCancelled in interface Future<R>
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface Future<R>
  - get
```
public R get()
      throws InterruptedException,
             ExecutionException
```
    Specified by:
    
    get in interface Future<R>
    
    Throws:
    
    InterruptedException
    
    ExecutionException
  - get
```
public R get(long time,
             TimeUnit timeUnit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException
```
    Specified by:
    
    get in interface Future<R>
    
    Throws:
    
    InterruptedException
    
    ExecutionException
    
    TimeoutException
  - getSize
```
public void getSize(SizeReadyCallback cb)
```
    A callback that should never be invoked directly.
    
    Specified by:
    
    getSize in interface Target<R>
    
    Parameters:
    
    cb - The callback that must be called when the size of the target has been determined
  - removeCallback
```
public void removeCallback(SizeReadyCallback cb)
```
    Description copied from interface: Target
    
    Removes the given callback from the pending set if it's still retained.
    
    Specified by:
    
    removeCallback in interface Target<R>
    
    Parameters:
    
    cb - The callback to remove.
  - setRequest
```
public void setRequest(@Nullable
                       Request request)
```
    Description copied from interface: Target
    
    Sets the current request for this target to retain, should not be called outside of Glide.
    
    Specified by:
    
    setRequest in interface Target<R>
  - getRequest
```
@Nullable
public Request getRequest()
```
    Description copied from interface: Target
    
    Retrieves the current request for this target, should not be called outside of Glide.
    
    Specified by:
    
    getRequest in interface Target<R>
  - onLoadCleared
```
public void onLoadCleared(Drawable placeholder)
```
    A callback that should never be invoked directly.
    
    Specified by:
    
    onLoadCleared in interface Target<R>
    
    Parameters:
    
    placeholder - The placeholder drawable to optionally show, or null.
  - onLoadStarted
```
public void onLoadStarted(Drawable placeholder)
```
    A callback that should never be invoked directly.
    
    Specified by:
    
    onLoadStarted in interface Target<R>
    
    Parameters:
    
    placeholder - The placeholder drawable to optionally show, or null.
  - onLoadFailed
```
public void onLoadFailed(Drawable errorDrawable)
```
    A callback that should never be invoked directly.
    
    Specified by:
    
    onLoadFailed in interface Target<R>
    
    Parameters:
    
    errorDrawable - The error drawable to optionally show, or null.
  - onResourceReady
```
public void onResourceReady(R resource,
                            Transition<? super R> transition)
```
    A callback that should never be invoked directly.
    
    Specified by:
    
    onResourceReady in interface Target<R>
    
    Parameters:
    
    resource - the loaded resource.
  - run
```
public void run()
```
    A callback that should never be invoked directly.
    
    Specified by:
    
    run in interface Runnable
  - onStart
```
public void onStart()
```
    Description copied from interface: LifecycleListener
    
    Callback for when Fragment.onStart()} or Activity.onStart() is called.
    
    Specified by:
    
    onStart in interface LifecycleListener
  - onStop
```
public void onStop()
```
    Description copied from interface: LifecycleListener
    
    Callback for when Fragment.onStop()} or Activity.onStop()} is called.
    
    Specified by:
    
    onStop in interface LifecycleListener
  - onDestroy
```
public void onDestroy()
```
    Description copied from interface: LifecycleListener
    
    Callback for when Fragment.onDestroy()} or Activity.onDestroy() is called.
    
    Specified by:
    
    onDestroy in interface LifecycleListener
  - onLoadFailed
```
public boolean onLoadFailed(@Nullable
                            GlideException e,
                            Object model,
                            Target<R> target,
                            boolean isFirstResource)
```
    Description copied from interface: RequestListener
    Called when an exception occurs during a load, immediately before Target.onLoadFailed(Drawable). Will only be called if we currently want to display an image for the given model in the given target. It is recommended to create a single instance per activity/fragment rather than instantiate a new object for each call to Glide.load() to avoid object churn.
    It is safe to reload this or a different model or change what is displayed in the target at this point. For example:
```
 
 public void onLoadFailed(Exception e, T model, Target target, boolean isFirstResource) {
     target.setPlaceholder(R.drawable.a_specific_error_for_my_exception);
     Glide.load(model).into(target);
 }
 
 
```
    Note - if you want to reload this or any other model after an exception, you will need to include all relevant builder calls (like centerCrop, placeholder etc).
    Specified by:
    
    onLoadFailed in interface RequestListener<R>
    
    Parameters:
    
    e - The maybe null exception containing information about why the request failed.
    
    model - The model we were trying to load when the exception occurred.
    
    target - The Target we were trying to load the image into.
    
    isFirstResource - true if this exception is for the first resource to load.
    
    Returns:
    
    true if the listener has handled updating the target for the given exception, false to allow Glide's request to update the target.
  - onResourceReady
```
public boolean onResourceReady(R resource,
                               Object model,
                               Target<R> target,
                               DataSource dataSource,
                               boolean isFirstResource)
```
    Description copied from interface: RequestListener
    
    Called when a load completes successfully, immediately before Target.onResourceReady(Object, com.bumptech.glide.request.transition.Transition).
    
    Specified by:
    
    onResourceReady in interface RequestListener<R>
    
    Parameters:
    
    resource - The resource that was loaded for the target.
    
    model - The specific model that was used to load the image.
    
    target - The target the model was loaded into.
    
    dataSource - The DataSource the resource was loaded from.
    
    isFirstResource - true if this is the first resource to in this load to be loaded into the target. For example when loading a thumbnail and a full-sized image, this will be true for the first image to load and false for the second.
    
    Returns:
    
    true if the listener has handled setting the resource on the target, false to allow Glide's request to update the target. Setting the resource includes handling animations, be sure to take that into account.

Class RequestFutureTarget<R>

Field Summary

Fields inherited from interface com.bumptech.glide.request.target.Target

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestFutureTarget

Method Detail

cancel

isCancelled

isDone

get

get

getSize

removeCallback

setRequest

getRequest

onLoadCleared

onLoadStarted

onLoadFailed

onResourceReady

run

onStart

onStop

onDestroy

onLoadFailed

onResourceReady