Summary: Methods | [Expand All]
public interface

ProducerListener

com.facebook.imagepipeline.producers.ProducerListener
Known Indirect Subclasses

Class Overview

Instrumentation for Producers.

Implementation of a producer should call these methods when appropriate to notify other components interested in execution progress.

Summary

Public Methods
abstract void onProducerEvent(String requestId, String producerName, String eventName)
Called whenever an important producer-specific event occurs.
abstract void onProducerFinishWithCancellation(String requestId, String producerName, Map<String, String> extraMap)
Called once when producer finishes due to cancellation.
abstract void onProducerFinishWithFailure(String requestId, String producerName, Throwable t, Map<String, String> extraMap)
Called when producer finishes processing current unit of work due to an error.
abstract void onProducerFinishWithSuccess(String requestId, String producerName, Map<String, String> extraMap)
Called when a producer successfully finishes processing current unit of work.
abstract void onProducerStart(String requestId, String producerName)
Called whenever a producer starts processing unit of work.
abstract void onUltimateProducerReached(String requestId, String producerName, boolean successful)
Called when the producer which can create the final result for a given request has completed.
abstract boolean requiresExtraMap(String requestId)

Public Methods

public abstract void onProducerEvent (String requestId, String producerName, String eventName)

Called whenever an important producer-specific event occurs. This may only be called if onProducerStart has been called, but corresponding onProducerFinishWith* method has not been called yet.

public abstract void onProducerFinishWithCancellation (String requestId, String producerName, Map<String, String> extraMap)

Called once when producer finishes due to cancellation.

Parameters
extraMap Additional parameters about the producer. This map is immutable and will throw an exception if attempts are made to modify it.

public abstract void onProducerFinishWithFailure (String requestId, String producerName, Throwable t, Map<String, String> extraMap)

Called when producer finishes processing current unit of work due to an error.

Parameters
extraMap Additional parameters about the producer. This map is immutable and will throw an exception if attempts are made to modify it.

public abstract void onProducerFinishWithSuccess (String requestId, String producerName, Map<String, String> extraMap)

Called when a producer successfully finishes processing current unit of work.

Parameters
extraMap Additional parameters about the producer. This map is immutable and will throw an exception if attempts are made to modify it.

public abstract void onProducerStart (String requestId, String producerName)

Called whenever a producer starts processing unit of work. This method might be called multiple times, but between any two consecutive calls to onProducerStart onProducerFinishWithSuccess will be called exactly once.

public abstract void onUltimateProducerReached (String requestId, String producerName, boolean successful)

Called when the producer which can create the final result for a given request has completed.

This can be used to determine which producer was best able to satisfy the request.

public abstract boolean requiresExtraMap (String requestId)

Returns
  • true if listener makes use of extra map