ContextQMD
Back to Fresco

SimpleDataSource

docs/javadoc/reference/com/facebook/datasource/SimpleDataSource.html

3.6.018.8 KB
Original Source

Fresco

|

|

Packages | Classes

Interfaces

Classes

Packages | Classes

Summary: Methods | Inherited Methods | [Expand All]

public class

SimpleDataSource

extends AbstractDataSource<T>

| java.lang.Object | | ↳ | com.facebook.datasource.AbstractDataSource<T> | | | ↳ | com.facebook.datasource.SimpleDataSource<T> |

Class Overview

Settable DataSource.

Summary

Public Methods
static <T> SimpleDataSource<T>
Creates a new SimpleDataSource.
boolean
Sets the failure.
boolean
Sets the progress.
boolean
Sets the value as the last result.
boolean
Sets the result to value.

| [Expand] Inherited Methods | | --- | | 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. |

|

Public Methods

public static SimpleDataSource<T> create()

Creates a new SimpleDataSource.

public boolean setFailure(Throwable throwable)

Sets the failure.

This method will return true if the failure was successfully set, or false if the data source has already been set, failed or closed.

If the failure was successfully set, state of the data source will be set to AbstractDataSource.DataSourceStatus#FAILURE.

This will also notify the subscribers if the failure was successfully set.

Parameters

| throwable | the failure cause to be set. |

Returns
  • true if the failure was successfully set.

public boolean setProgress(float progress)

Sets the progress.

Parameters

| progress | the progress in range [0, 1] to be set. |

Returns
  • true if the progress was successfully set.

public boolean setResult(T value)

Sets the value as the last result.

See setResult(T, boolean).

public boolean setResult(T value, boolean isLast, Map<String, Object> extras)

Sets the result to value.

This method will return true if the value was successfully set, or false if the data source has already been set, failed or closed.

If the value was successfully set and isLast is true, state of the data source will be set to AbstractDataSource.DataSourceStatus#SUCCESS.

This will also notify the subscribers if the value was successfully set.

Parameters

| value | the value to be set | | isLast | whether or not the value is last. | | extras | an object with extra data for this datasource |

Returns
  • true if the value was successfully set.

+Generated by Doclava. +