co.easimart.GetDataStreamCallback Maven / Gradle / Ivy

Go to download
package co.easimart;

import java.io.InputStream;

/**
 * A {@code GetDataStreamCallback} is used to run code after a {@link EasimartFile} fetches its data on
 * a background thread.
 * 
 * The easiest way to use a {@code GetDataStreamCallback} is through an anonymous inner class.
 * Override the {@code done} function to specify what the callback should do after the fetch is
 * complete. The {@code done} function will be run in the UI thread, while the fetch happens in a
 * background thread. This ensures that the UI does not freeze while the fetch happens.
 * 

 * 
 * file.getDataStreamInBackground(new GetDataStreamCallback() {
 *   public void done(InputSteam input, EasimartException e) {
 *     // ...
 *   }
 * });
 * 
 */
public interface GetDataStreamCallback extends EasimartCallback2 {
  /**
   * Override this function with the code you want to run after the fetch is complete.
   *
   * @param input
   *          The data that was retrieved, or {@code null} if it did not succeed.
   * @param e
   *          The exception raised by the fetch, or {@code null} if it succeeded.
   */
  @Override
  public void done(InputStream input, EasimartException e);
}