Package 

Class ErrorRequestCoordinator

  • All Implemented Interfaces:
    com.mobwith.imgmodule.request.Request , com.mobwith.imgmodule.request.RequestCoordinator 
    
public final class ErrorRequestCoordinator
 implements RequestCoordinator, Request

    Runs a single primary Request until it completes and then a fallback error request only if the single primary request fails.

    • Method Summary

      Modifier and Type Method Description
      void setRequests(Request primary, Request error)
      void begin() Starts an asynchronous load.
      void clear() Prevents any bitmaps being loaded from previous requests, releases any resources held by thisrequest, displays the current placeholder if one was provided, and marks the request as havingbeen cancelled.
      void pause() Similar to clear for in progress requests (or portions of a request), but does nothingif the request is already complete.
      boolean isRunning() Returns true if this request is running and has not completed or failed.
      boolean isComplete() Returns true if the request has completed successfully.
      boolean isCleared() Returns true if the request has been cleared.
      boolean isEquivalentTo(Request o) Returns {@code true} if this Request is equivalent to the given Request (hasall of the same options and sizes).
      boolean canSetImage(Request request) Returns true if the Request can display a loaded bitmap.
      boolean canNotifyStatusChanged(Request request) Returns true if the Request can display a placeholder.
      boolean canNotifyCleared(Request request) Returns {@code true} if the Request can clear the .
      boolean isAnyResourceSet() Returns true if any coordinated Request has successfully completed.
      void onRequestSuccess(Request request) Must be called when a Request coordinated by this object completes successfully.
      void onRequestFailed(Request request) Must be called when a Request coordinated by this object fails.
      RequestCoordinator getRoot() Returns the top most parent {@code RequestCoordinator}.

      • Methods inherited from class com.mobwith.imgmodule.request.Request

        isEquivalentTo

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • begin

         void begin()

        Starts an asynchronous load.

      • clear

         void clear()

        Prevents any bitmaps being loaded from previous requests, releases any resources held by thisrequest, displays the current placeholder if one was provided, and marks the request as havingbeen cancelled.

      • pause

         void pause()

        Similar to clear for in progress requests (or portions of a request), but does nothingif the request is already complete.

        Unlike clear, this method allows implementations to act differently on subpartsof a request. For example if a Request has both a thumbnail and a primary request and thethumbnail portion of the request is complete, this method allows only the primary portion ofthe request to be paused without clearing the previously completed thumbnail portion.

      • isRunning

         boolean isRunning()

        Returns true if this request is running and has not completed or failed.

      • isComplete

         boolean isComplete()

        Returns true if the request has completed successfully.

      • isCleared

         boolean isCleared()

        Returns true if the request has been cleared.

      • isEquivalentTo

         boolean isEquivalentTo(Request o)

        Returns {@code true} if this Request is equivalent to the given Request (hasall of the same options and sizes).

        This method is identical to equals except that it's specific to Request subclasses. We do not use equals directly because wetrack Requests in collections like java.util.Set and it's perfectly legitimateto have two different Request objects for two different s (for example). Using a similar but different methodlet's us selectively compare Request objects to each other when it's useful in specificscenarios.

      • canSetImage

         boolean canSetImage(Request request)

        Returns true if the Request can display a loaded bitmap.

        Parameters:
        request - The Request requesting permission to display a bitmap.