ContextQMD
Back to Fresco

CloseableProducerToDataSourceAdapter

docs/javadoc/reference/com/facebook/imagepipeline/datasource/CloseableProducerToDataSourceAdapter.html

3.6.022.3 KB
Original Source

Fresco

|

|

Packages | Classes

Classes

Packages | Classes

Summary: Methods | Protected Methods | Inherited Methods | [Expand All]

public class

CloseableProducerToDataSourceAdapter

extends AbstractProducerToDataSourceAdapter<T>

| java.lang.Object | | ↳ | com.facebook.datasource.AbstractDataSource<T> | | | ↳ | com.facebook.imagepipeline.datasource.AbstractProducerToDataSourceAdapter<T> | | | | ↳ | com.facebook.imagepipeline.datasource.CloseableProducerToDataSourceAdapter<T> |

Class Overview

DataSource> backed by a Producer>

Summary

Public Methods
static <T> DataSource<CloseableReference<T>>
CloseableReference<T>
The most recent result of the asynchronous computation.
Protected Methods
void
Subclasses should override this method to close the result that is not needed anymore.
void

| [Expand] Inherited Methods | | --- | | From class com.facebook.imagepipeline.datasource.AbstractProducerToDataSourceAdapter

| boolean | close() Cancels the ongoing request and releases all associated resources. | | Map<String, Object> | getExtras(ProducerContext producerContext) | | ImageRequest | getImageRequest() | | void | onNewResultImpl(T result, int status, ProducerContext producerContext) |

| | From class com.facebook.datasource.AbstractDataSource

| boolean | close() Cancels the ongoing request and releases all associated resources. | | void | closeResult(T result) Subclasses should override this method to close the result that is not needed anymore. | | static AbstractDataSource.DataSourceInstrumenter | getDataSourceInstrumenter() | | Map<String, Object> | getExtras() | | synchronized Throwable | getFailureCause() | | synchronized float | getProgress() | | synchronized T | getResult() The most recent result of the asynchronous computation. | | synchronized boolean | hasFailed() | | boolean | hasMultipleResults() | | synchronized boolean | hasResult() | | synchronized boolean | isClosed() | | synchronized boolean | isFinished() | | void | notifyDataSubscriber(DataSubscriber<T> dataSubscriber, Executor executor, boolean isFailure, boolean isCancellation) | | void | notifyProgressUpdate() | | static void | provideInstrumenter(AbstractDataSource.DataSourceInstrumenter dataSourceInstrumenter) | | void | setExtras(Map<String, Object> extras) | | boolean | setFailure(Throwable throwable) Subclasses should invoke this method to set the failure. | | boolean | setFailure(Throwable throwable, Map<String, Object> extras) | | boolean | setProgress(float progress) Subclasses should invoke this method to set the progress. | | boolean | setResult(T value, boolean isLast, Map<String, Object> extras) Subclasses should invoke this method to set the result to value. | | boolean | setResult(T value, boolean isLast) | | void | subscribe(DataSubscriber<T> dataSubscriber, Executor executor) Subscribe for notifications whenever the state of the DataSource changes. |

| | From class java.lang.Object

| Object | clone() | | boolean | equals(Object arg0) | | void | finalize() | | final Class<?> | getClass() | | int | hashCode() | | final void | notify() | | final void | notifyAll() | | String | toString() | | final void | wait(long arg0, int arg1) | | final void | wait(long arg0) | | final void | wait() |

| | From interface com.facebook.datasource.DataSource

| abstract boolean | close() Cancels the ongoing request and releases all associated resources. | | abstract Map<String, Object> | getExtras() | | abstract Throwable | getFailureCause() | | abstract float | getProgress() | | abstract T | getResult() The most recent result of the asynchronous computation. | | abstract boolean | hasFailed() | | abstract boolean | hasMultipleResults() | | abstract boolean | hasResult() | | abstract boolean | isClosed() | | abstract boolean | isFinished() | | abstract void | subscribe(DataSubscriber<T> dataSubscriber, Executor executor) Subscribe for notifications whenever the state of the DataSource changes. |

| | From interface com.facebook.imagepipeline.request.HasImageRequest

| abstract ImageRequest | getImageRequest() |

|

Public Methods

public static DataSource<CloseableReference<T>> create(Producer<CloseableReference<T>> producer, SettableProducerContext settableProducerContext, RequestListener2 listener)

public CloseableReference<T> getResult()

The most recent result of the asynchronous computation.

The caller gains ownership of the object and is responsible for releasing it. Note that subsequent calls to getResult might give different results. Later results should be considered to be of higher quality.

This method will return null in the following cases:

  • when the DataSource does not have a result (hasResult returns false).
  • when the last result produced was null.
Returns
  • current best result

Protected Methods

protected void closeResult(CloseableReference<T> result)

Subclasses should override this method to close the result that is not needed anymore.

This method is called in two cases: 1. to clear the result when data source gets closed 2. to clear the previous result when a new result is set

protected void onNewResultImpl(CloseableReference<T> result, int status, ProducerContext producerContext)

+Generated by Doclava. +