Java.libraries.okhttp-gson.ApiCallback.mustache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-codegen Show documentation

There is a newer version: 3.0.0-rc1

package {{invokerPackage}};

import java.io.IOException;

import java.util.Map;
import java.util.List;

/**
 * Callback for asynchronous API call.
 *
 * @param  The return type
 */
public interface ApiCallback {
  /**
   * This is called when the API call fails.
   *
   * @param e The exception causing the failure
   * @param statusCode Status code of the response if available, otherwise it would be 0
   * @param responseHeaders Headers of the response if available, otherwise it would be null
   */
  void onFailure(ApiException e, int statusCode, Map> responseHeaders);

  /**
   * This is called when the API call succeeded.
   *
   * @param result The result deserialized from response
   * @param statusCode Status code of the response
   * @param responseHeaders Headers of the response
   */
  void onSuccess(T result, int statusCode, Map> responseHeaders);

  /**
   * This is called when the API upload processing.
   *
   * @param bytesWritten bytes Written
   * @param contentLength content length of request body
   * @param done write end
   */
  void onUploadProgress(long bytesWritten, long contentLength, boolean done);

  /**
   * This is called when the API downlond processing.
   *
   * @param bytesRead bytes Read
   * @param contentLength content lenngth of the response
   * @param done Read end
   */
  void onDownloadProgress(long bytesRead, long contentLength, boolean done);
}