Home | History | Annotate | Download | only in request
      1 package com.bumptech.glide.request;
      2 
      3 /**
      4  * A request that loads a resource for an {@link com.bumptech.glide.request.target.Target}.
      5  */
      6 public interface Request {
      7 
      8     /**
      9      * Starts an asynchronous load.
     10      */
     11     void begin();
     12 
     13     /**
     14      * Identical to {@link #clear()} except that the request may later be restarted.
     15      */
     16     void pause();
     17 
     18     /**
     19      * Prevents any bitmaps being loaded from previous requests, releases any resources held by this request,
     20      * displays the current placeholder if one was provided, and marks the request as having been cancelled.
     21      */
     22     void clear();
     23 
     24     /**
     25      * Returns true if this request is paused and may be restarted.
     26      */
     27     boolean isPaused();
     28 
     29     /**
     30      * Returns true if this request is running and has not completed or failed.
     31      */
     32     boolean isRunning();
     33 
     34     /**
     35      * Returns true if the request has completed successfully.
     36      */
     37     boolean isComplete();
     38 
     39     /**
     40      * Returns true if a non-placeholder resource is set. For Requests that load more than one resource, isResourceSet
     41      * may return true even if {@link #isComplete()}} returns false.
     42      */
     43     boolean isResourceSet();
     44 
     45     /**
     46      * Returns true if the request has been cancelled.
     47      */
     48     boolean isCancelled();
     49 
     50     /**
     51      * Returns true if the request has failed.
     52      */
     53     boolean isFailed();
     54 
     55     /**
     56      * Recycles the request object and releases its resources.
     57      */
     58     void recycle();
     59 }
     60