com.facebook.litho.testing.logging

Class TestComponentsLogger

java.lang.Object

com.facebook.litho.testing.logging.TestComponentsLogger

All Implemented Interfaces:

ComponentsLogger

public class TestComponentsLogger
extends java.lang.Object
implements ComponentsLogger

In test environments we don't want to recycle the events as mockity hold on to them. We therefor override log() to not call release.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.litho.ComponentsLogger

ComponentsLogger.LogLevel

Constructor Summary

Constructors

Constructor and Description
TestComponentsLogger()

Method Summary

Modifier and Type	Method and Description
void	cancelPerfEvent(PerfEvent event) Release a previously obtained PerfEvent without logging it.
java.util.List<PerfEvent>	getCanceledPerfEvents()
java.util.Map<java.lang.String,java.lang.String>	getExtraAnnotations(TreeProps treeProps) Provide additional log metadata based on the tree props of the component hierarchy currently being logged.
java.util.List<PerfEvent>	getLoggedPerfEvents()
boolean	isTracing(PerfEvent logEvent)
void	logPerfEvent(PerfEvent event) Write a PerfEvent to storage.
PerfEvent	newPerformanceEvent(ComponentContext c, int eventId) Create a new performance event with the given event id and start counting the time.
void	reset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestComponentsLogger

public TestComponentsLogger()

Method Detail

isTracing

public boolean isTracing(PerfEvent logEvent)

Specified by:

isTracing in interface ComponentsLogger

Returns:

whether this event is being traced and getting logged.

newPerformanceEvent

public PerfEvent newPerformanceEvent(ComponentContext c,
                                     int eventId)

Description copied from interface: ComponentsLogger

Create a new performance event with the given event id and start counting the time. If the logger doesn't care about this event id, it may return null.

Specified by:

newPerformanceEvent in interface ComponentsLogger

cancelPerfEvent

public void cancelPerfEvent(PerfEvent event)

Description copied from interface: ComponentsLogger

Release a previously obtained PerfEvent without logging it.

Specified by:

cancelPerfEvent in interface ComponentsLogger

logPerfEvent

public void logPerfEvent(PerfEvent event)

Description copied from interface: ComponentsLogger

Write a PerfEvent to storage. This also marks the end of the event.

Specified by:

logPerfEvent in interface ComponentsLogger

getLoggedPerfEvents

public java.util.List<PerfEvent> getLoggedPerfEvents()

getCanceledPerfEvents

public java.util.List<PerfEvent> getCanceledPerfEvents()

reset

public void reset()

getExtraAnnotations

public java.util.Map<java.lang.String,java.lang.String> getExtraAnnotations(TreeProps treeProps)

Description copied from interface: ComponentsLogger

Provide additional log metadata based on the tree props of the component hierarchy currently being logged. This can be useful if information about the component hierarchy is needed.

Specified by:

getExtraAnnotations in interface ComponentsLogger

Parameters:

treeProps - The treeprops available in the hierarchy.

Returns:

Null for efficiency purposes when no data needs to be logged, associative map otherwise.