com.facebook.litho.testing.sections

Class SectionsTestHelper

java.lang.Object

com.facebook.litho.sections.SectionLifecycle

com.facebook.litho.sections.Section

com.facebook.litho.testing.sections.SectionsTestHelper

All Implemented Interfaces:

Equivalence<Section>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, Cloneable

public class SectionsTestHelper
extends Section

A helper for testing section components.

Allows testing a GroupsSectionSpec's direct children without building the whole hieararchy. Also allows simpler State updates testing by keeping trach of a scoped section context.

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.litho.sections.Section

Section.Builder<T extends Section.Builder<T>>

Constructor Summary

Constructors

Constructor and Description
SectionsTestHelper(Context c)

Method Summary

Modifier and Type	Method and Description
static Object	dispatchEvent(HasEventDispatcher section, EventHandler eventHandler, Object event) Dispatches an event to the section
List<SubSection>	getChildren(Section section) Get child sections for the given section.
SectionContext	getContext() Return a generic SectionContext you can use to create sections.
SectionContext	getScopedContext(Section s) Return the specific SectionContext that's been scoped to the given section.
<T extends StateContainer> T	getStateContainer(Section section) Get the state container of the given section.
static List<SubSection>	getSubSections(Children children) Get sub sections for the given Children.
boolean	isEquivalentTo(Section other) Compares this section to a different one to check if they are the same
Section	prepare(Section s) Prepare section for testing.

Methods inherited from class com.facebook.litho.sections.Section

generateUniqueGlobalKeyForChild, getChildren, getEventDispatcher, getGlobalKey, getHandle, getKey, getLogTag, getParent, getScopedContext, getSimpleName, getStateContainer, makeShallowCopy, makeShallowCopy, recordEventTrigger, setChildren, setCount, setGlobalKey, setKey, setScopedContext

Methods inherited from class com.facebook.litho.sections.SectionLifecycle

acceptTriggerEvent, bindService, createChildren, createInitialState, createService, dataBound, dataRendered, dispatchLoadingEvent, dispatchOnEvent, generateChangeSet, getEventTrigger, getEventTrigger, getLoadingEventHandler, getService, getTreePropsForChildren, isDiffSectionSpec, isSectionIndexValid, newEventHandler, newEventHandler, newEventTrigger, populateTreeProps, refresh, requestFocus, requestFocus, requestFocus, requestFocusWithOffset, requestFocusWithOffset, requestFocusWithOffset, requestSmoothFocus, requestSmoothFocus, requestSmoothFocus, shouldUpdate, transferService, transferState, unbindService, viewportChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionsTestHelper

public SectionsTestHelper(Context c)

Method Detail

isEquivalentTo

public boolean isEquivalentTo(Section other)

Description copied from class: Section

Compares this section to a different one to check if they are the same

This is used to be able to skip rendering a section again. We avoid using the Object.equals(Object) so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.

Specified by:

isEquivalentTo in interface Equivalence<Section>

Overrides:

isEquivalentTo in class Section

Parameters:

other - the component to compare to

Returns:

true if the components are of the same type and have the same props

getContext

public SectionContext getContext()

Return a generic SectionContext you can use to create sections.

getScopedContext

public SectionContext getScopedContext(Section s)

Return the specific SectionContext that's been scoped to the given section.

prepare

public Section prepare(Section s)

Prepare section for testing.

Prepare sets up a proper scoped SectionContext we can use to test lifecycle methods and state updates. It also prepares the given section for use by calling lifecycle methods like onCreateInitialState.

getChildren

public List<SubSection> getChildren(Section section)

Get child sections for the given section.

Parameters:

section - The section under test.

Returns:

A list of the children created by the given section.

getSubSections

public static List<SubSection> getSubSections(Children children)

Get sub sections for the given Children. This is very similar to getChildren(Section) except it gets the Children intead of calling createChildren. This is useful for testing the output of RenderSectionEvent handlers.

Parameters:

children - The Children object to extract sections from.

Returns:

A list of the sections inside the given Children object.

getStateContainer

public <T extends StateContainer> T getStateContainer(Section section)

Get the state container of the given section.

Type Parameters:

T - The section's StateContainer class

Parameters:

section - The section for which you want the state values from.

Returns:

the state container.

dispatchEvent

public static Object dispatchEvent(HasEventDispatcher section,
                                   EventHandler eventHandler,
                                   Object event)

Dispatches an event to the section

Parameters:

section - the section under test

eventHandler - the event handler to execute

event - the event object

Returns:

the event's return value if the event expects to return anything. Otherwise null.