hu.akarnokd.rxjava3.retrofit.Result Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava3-retrofit-adapter Show documentation
RxJava 3 adapter for Retrofit 2
The newest version!
/*
 * Copyright (C) 2015 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hu.akarnokd.rxjava3.retrofit;

import java.io.IOException;

import io.reactivex.rxjava3.annotations.Nullable;
import retrofit2.Response;

/** 
 * The result of executing an HTTP request.
 * @param  the value type of the result 
 */
public final class Result {
  public static  Result error(Throwable error) {
    if (error == null) throw new NullPointerException("error == null");
    return new Result<>(null, error);
  }

  public static  Result response(Response response) {
    if (response == null) throw new NullPointerException("response == null");
    return new Result<>(response, null);
  }

  private final @Nullable Response response;
  private final @Nullable Throwable error;

  private Result(@Nullable Response response, @Nullable Throwable error) {
    this.response = response;
    this.error = error;
  }

  /**
   * The response received from executing an HTTP request. Only present when {@link #isError()} is
   * false, null otherwise.
   * @return the response object
   */
  public @Nullable Response response() {
    return response;
  }

  /**
   * The error experienced while attempting to execute an HTTP request. Only present when {@link
   * #isError()} is true, null otherwise.
   * 
   * If the error is an {@link 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.).
   * 
   * @return the Throwable error
   */
  public @Nullable Throwable error() {
    return error;
  }

  /** 
   * {@code true} if the request resulted in an error. See {@link #error()} for the cause.
   * @return {@code true} if the request resulted in an error
   */
  public boolean isError() {
    return error != null;
  }
}