Class Result<T>

  • Type Parameters:
    T - the value type of the result

    public final class Result<T>
    extends java.lang.Object
    The result of executing an HTTP request.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @Nullable java.lang.Throwable error()
      The error experienced while attempting to execute an HTTP request.
      static <T> Result<T> error​(java.lang.Throwable error)  
      boolean isError()
      true if the request resulted in an error.
      @Nullable retrofit2.Response<T> response()
      The response received from executing an HTTP request.
      static <T> Result<T> response​(retrofit2.Response<T> response)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • error

        public static <T> Result<T> error​(java.lang.Throwable error)
      • response

        public static <T> Result<T> response​(retrofit2.Response<T> response)
      • response

        @Nullable
        public @Nullable retrofit2.Response<T> response()
        The response received from executing an HTTP request. Only present when isError() is false, null otherwise.
        Returns:
        the response object
      • error

        @Nullable
        public @Nullable java.lang.Throwable error()
        The error experienced while attempting to execute an HTTP request. Only present when isError() is true, null otherwise.

        If the error is an IOException then there was a problem with the transport to the remote server. Any other exception type indicates an unexpected failure and should be considered fatal (configuration error, programming error, etc.).

        Returns:
        the Throwable error
      • isError

        public boolean isError()
        true if the request resulted in an error. See error() for the cause.
        Returns:
        true if the request resulted in an error