public class

InternalProducerListener

extends Object
implements ProducerListener2
java.lang.Object
   ↳ com.facebook.imagepipeline.producers.InternalProducerListener
Known Direct Subclasses

Summary

Public Constructors
InternalProducerListener(ProducerListener producerListener, ProducerListener2 producerListener2)
Public Methods
ProducerListener getProducerListener()
ProducerListener2 getProducerListener2()
void onProducerEvent(ProducerContext context, String producerName, String eventName)
Called whenever an important producer-specific event occurs.
void onProducerFinishWithCancellation(ProducerContext context, String producerName, Map<String, String> extraMap)
Called once when producer finishes due to cancellation.
void onProducerFinishWithFailure(ProducerContext context, String producerName, Throwable t, Map<String, String> extraMap)
Called when producer finishes processing current unit of work due to an error.
void onProducerFinishWithSuccess(ProducerContext context, String producerName, Map<String, String> extraMap)
Called when a producer successfully finishes processing current unit of work.
void onProducerStart(ProducerContext context, String producerName)
Called whenever a producer starts processing unit of work.
void onUltimateProducerReached(ProducerContext context, String producerName, boolean successful)
Called when the producer which can create the final result for a given request has completed.
boolean requiresExtraMap(ProducerContext context, String producerName)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.facebook.imagepipeline.producers.ProducerListener2

Public Constructors

public InternalProducerListener (ProducerListener producerListener, ProducerListener2 producerListener2)

Public Methods

public ProducerListener getProducerListener ()

public ProducerListener2 getProducerListener2 ()

public void onProducerEvent (ProducerContext context, 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 void onProducerFinishWithCancellation (ProducerContext context, 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 void onProducerFinishWithFailure (ProducerContext context, 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 void onProducerFinishWithSuccess (ProducerContext context, 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 void onProducerStart (ProducerContext context, 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 void onUltimateProducerReached (ProducerContext context, 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 boolean requiresExtraMap (ProducerContext context, String producerName)