Back to Fresco

ProducerContext

docs/javadoc/reference/com/facebook/imagepipeline/producers/ProducerContext.html

3.6.025.1 KB
Original Source

Fresco

|

|

Packages | Classes

Interfaces

Classes

Annotations

Packages | Classes

Summary: Nested Classes | Methods | [Expand All]

public interface

ProducerContext

| com.facebook.imagepipeline.producers.ProducerContext |

| Known Indirect Subclasses

BaseProducerContext, SettableProducerContext

| BaseProducerContext | ProducerContext that can be cancelled. | | SettableProducerContext | ProducerContext that allows the client to change its internal state. |

|

Class Overview

Used to pass context information to producers.

Object implementing this interface is passed to all producers participating in pipeline request . Its responsibility is to instruct producers which image should be fetched/decoded/resized/cached etc. This class also handles request cancellation.

In order to be notified when cancellation is requested, a producer should use the runOnCancellationRequested method which takes an instance of Runnable and executes it when the pipeline client cancels the image request.

See Also
  • produceResults(Consumer, ProducerContext)

Summary

Nested Classes
@interface
Public Methods
abstract void
Adds callbacks to the set of callbacks that are executed at various points during the processing of a request.
abstract Object
abstract EncodedImageOrigin
abstract <E> E
abstract <E> E
abstract Map<String, Object>
abstract String
abstract ImagePipelineConfig
abstract ImageRequest
abstract ImageRequest.RequestLevel
abstract Priority
abstract ProducerListener2
abstract String
abstract boolean
abstract boolean
abstract void
abstract void
Helper to set ORIGIN
abstract void
Helper to set ORIGIN and ORIGIN_SUBCATEGORY
abstract void
abstract <E> void

Public Methods

public abstract void addCallbacks(ProducerContextCallbacks callbacks)

Adds callbacks to the set of callbacks that are executed at various points during the processing of a request.

Parameters

| callbacks | callbacks to be executed |

public abstract Object getCallerContext()

Returns
  • the Object that indicates the caller's context

public abstract EncodedImageOrigin getEncodedImageOrigin()

public abstract E getExtra(String key, E valueIfNotFound)

public abstract E getExtra(String key)

public abstract Map<String, Object> getExtras()

public abstract String getId()

Returns
  • id of this request

public abstract ImagePipelineConfig getImagePipelineConfig()

public abstract ImageRequest getImageRequest()

Returns
  • image request that is being executed

public abstract ImageRequest.RequestLevel getLowestPermittedRequestLevel()

Returns
  • the lowest permitted ImageRequest.RequestLevel

public abstract Priority getPriority()

Returns
  • priority of the request.

public abstract ProducerListener2 getProducerListener()

Returns
  • ProducerListener2 for producer's events

public abstract String getUiComponentId()

Returns
  • optional id of the UI component requesting the image

public abstract boolean isIntermediateResultExpected()

Returns
  • true if request's owner expects intermediate results

public abstract boolean isPrefetch()

Returns
  • true if the request is a prefetch, false otherwise.

public abstract void putExtras(Map<String, ?> extras)

public abstract void putOriginExtra(String origin)

Helper to set ORIGIN

public abstract void putOriginExtra(String origin, String subcategory)

Helper to set ORIGIN and ORIGIN_SUBCATEGORY

public abstract void setEncodedImageOrigin(EncodedImageOrigin encodedImageOrigin)

public abstract void setExtra(String key, E value)

+Generated by Doclava. +