LayoutSpecModel

java.lang.Object
- com.facebook.litho.specmodels.model.LayoutSpecModel

All Implemented Interfaces:

HasPureRender, SpecModel
```
public class LayoutSpecModel
extends Object
implements SpecModel, HasPureRender
```
Model that is an abstract representation of a com.facebook.litho.annotations.LayoutSpec.

Constructor Summary

Constructors
Constructor and Description
LayoutSpecModel(String qualifiedSpecClassName, String componentClassName, ImmutableList<SpecMethodModel<DelegateMethod,Void>> delegateMethods, ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> eventMethods, ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> triggerMethods, SpecMethodModel<EventMethod,Void> workingRangeRegisterMethod, ImmutableList<WorkingRangeMethodModel> workingRangeMethods, ImmutableList<SpecMethodModel<UpdateStateMethod,Void>> updateStateMethods, ImmutableList<SpecMethodModel<UpdateStateMethod,Void>> updateStateWithTransitionMethods, ImmutableList<String> cachedPropNames, ImmutableList<PropDefaultModel> propDefaults, ImmutableList<EventDeclarationModel> eventDeclarations, ImmutableList<AnnotationSpec> classAnnotations, ImmutableList<TagModel> tags, String classJavadoc, ImmutableList<PropJavadocModel> propJavadocs, boolean isPublic, DependencyInjectionHelper dependencyInjectionHelper, boolean isPureRender, SpecElementType specElementType, Object representedObject, SpecGenerator<LayoutSpecModel> layoutSpecGenerator, ImmutableList<TypeVariableName> typeVariables, ImmutableList<FieldModel> fields, String simpleNameDelegate)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TypeSpec`	`generate(EnumSet<RunMode> runMode)`
`ImmutableList<CachedValueParamModel>`	`getCachedValues()`
`ImmutableList<AnnotationSpec>`	`getClassAnnotations()`
`String`	`getClassJavadoc()`
`ClassName`	`getComponentClass()`
`String`	`getComponentName()`
`TypeName`	`getComponentTypeName()`
`ClassName`	`getContextClass()`
`ImmutableList<SpecMethodModel<DelegateMethod,Void>>`	`getDelegateMethods()`
`DependencyInjectionHelper`	`getDependencyInjectionHelper()`
`ImmutableList<EventDeclarationModel>`	`getEventDeclarations()`
`ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>>`	`getEventMethods()`
`ImmutableList<BuilderMethodModel>`	`getExtraBuilderMethods()`
`ImmutableList<FieldModel>`	`getFields()`
`ImmutableList<InjectPropModel>`	`getInjectProps()`
`ImmutableList<InterStageInputParamModel>`	`getInterStageInputs()`
`ImmutableList<PropDefaultModel>`	`getPropDefaults()`
`ImmutableList<PropJavadocModel>`	`getPropJavadocs()`
`ImmutableList<PropModel>`	`getProps()`
`ImmutableList<InjectPropModel>`	`getRawInjectProps()`
`ImmutableList<PropModel>`	`getRawProps()`
`ImmutableList<RenderDataDiffModel>`	`getRenderDataDiffs()`
`Object`	`getRepresentedObject()`
`String`	`getScopeMethodName()`
`String`	`getSimpleNameDelegate()`
`SpecElementType`	`getSpecElementType()`
`String`	`getSpecName()`
`ClassName`	`getSpecTypeName()`
`ClassName`	`getStateContainerClass()`
`ImmutableList<StateParamModel>`	`getStateValues()`
`ImmutableList<TagModel>`	`getTags()`
`ClassName`	`getTransitionClass()`
`ClassName`	`getTransitionContainerClass()`
`ImmutableList<TreePropModel>`	`getTreeProps()`
`ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>>`	`getTriggerMethods()`
`ImmutableList<TypeVariableName>`	`getTypeVariables()`
`ImmutableList<SpecMethodModel<UpdateStateMethod,Void>>`	`getUpdateStateMethods()`
`ImmutableList<SpecMethodModel<UpdateStateMethod,Void>>`	`getUpdateStateWithTransitionMethods()`
`ImmutableList<WorkingRangeMethodModel>`	`getWorkingRangeMethods()`
`SpecMethodModel<EventMethod,Void>`	`getWorkingRangeRegisterMethod()`
`boolean`	`hasDeepCopy()`
`boolean`	`hasInjectedDependencies()`
`boolean`	`isPublic()`
`boolean`	`isPureRender()` Whether this spec is pure render or not.
`boolean`	`isStylingSupported()`
`boolean`	`shouldCheckIdInIsEquivalentToMethod()`
`boolean`	`shouldGenerateCopyMethod()`
`boolean`	`shouldGenerateHasState()`
`boolean`	`shouldGenerateIsEquivalentTo()`
`String`	`toString()`
`List<SpecModelValidationError>`	`validate(EnumSet<RunMode> runMode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LayoutSpecModel
```
public LayoutSpecModel(String qualifiedSpecClassName,
                       String componentClassName,
                       ImmutableList<SpecMethodModel<DelegateMethod,Void>> delegateMethods,
                       ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> eventMethods,
                       ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> triggerMethods,
                       SpecMethodModel<EventMethod,Void> workingRangeRegisterMethod,
                       ImmutableList<WorkingRangeMethodModel> workingRangeMethods,
                       ImmutableList<SpecMethodModel<UpdateStateMethod,Void>> updateStateMethods,
                       ImmutableList<SpecMethodModel<UpdateStateMethod,Void>> updateStateWithTransitionMethods,
                       ImmutableList<String> cachedPropNames,
                       ImmutableList<PropDefaultModel> propDefaults,
                       ImmutableList<EventDeclarationModel> eventDeclarations,
                       ImmutableList<AnnotationSpec> classAnnotations,
                       ImmutableList<TagModel> tags,
                       String classJavadoc,
                       ImmutableList<PropJavadocModel> propJavadocs,
                       boolean isPublic,
                       DependencyInjectionHelper dependencyInjectionHelper,
                       boolean isPureRender,
                       SpecElementType specElementType,
                       Object representedObject,
                       SpecGenerator<LayoutSpecModel> layoutSpecGenerator,
                       ImmutableList<TypeVariableName> typeVariables,
                       ImmutableList<FieldModel> fields,
                       String simpleNameDelegate)
```
- Method Detail
  - getSpecName
```
public String getSpecName()
```
    Specified by:
    
    getSpecName in interface SpecModel
    
    Returns:
    
    the name of the spec.
  - getSpecTypeName
```
public ClassName getSpecTypeName()
```
    Specified by:
    
    getSpecTypeName in interface SpecModel
    
    Returns:
    
    the TypeName representing the name of the Spec.
  - getComponentName
```
public String getComponentName()
```
    Specified by:
    
    getComponentName in interface SpecModel
    
    Returns:
    
    the name of the component that will be generated from this model.
  - getComponentTypeName
```
public TypeName getComponentTypeName()
```
    Specified by:
    
    getComponentTypeName in interface SpecModel
    
    Returns:
    
    the TypeName representing the name of the component that will be generated from this model.
  - getFields
```
public ImmutableList<FieldModel> getFields()
```
    Specified by:
    
    getFields in interface SpecModel
    
    Returns:
    
    the list of fields defined in the spec.
  - getDelegateMethods
```
public ImmutableList<SpecMethodModel<DelegateMethod,Void>> getDelegateMethods()
```
    Specified by:
    
    getDelegateMethods in interface SpecModel
    
    Returns:
    
    the list of methods defined in the spec which will be delegated to by the component that is generated from this model.
  - getEventMethods
```
public ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> getEventMethods()
```
    Specified by:
    
    getEventMethods in interface SpecModel
    
    Returns:
    
    the list of event methods defined by the spec.
  - getTriggerMethods
```
public ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> getTriggerMethods()
```
    Specified by:
    
    getTriggerMethods in interface SpecModel
    
    Returns:
    
    the list of trigger methods defined by the spec.
  - getWorkingRangeRegisterMethod
```
public SpecMethodModel<EventMethod,Void> getWorkingRangeRegisterMethod()
```
    Specified by:
    
    getWorkingRangeRegisterMethod in interface SpecModel
    
    Returns:
    
    the working range register method defined by the spec.
  - getWorkingRangeMethods
```
public ImmutableList<WorkingRangeMethodModel> getWorkingRangeMethods()
```
    Specified by:
    
    getWorkingRangeMethods in interface SpecModel
    
    Returns:
    
    the list of working ranges methods defined by the spec.
  - getUpdateStateMethods
```
public ImmutableList<SpecMethodModel<UpdateStateMethod,Void>> getUpdateStateMethods()
```
    Specified by:
    
    getUpdateStateMethods in interface SpecModel
    
    Returns:
    
    the list of methods defined in the spec for updating state.
  - getUpdateStateWithTransitionMethods
```
public ImmutableList<SpecMethodModel<UpdateStateMethod,Void>> getUpdateStateWithTransitionMethods()
```
    Specified by:
    
    getUpdateStateWithTransitionMethods in interface SpecModel
    
    Returns:
    
    the list of methods defined in the spec for updating state with transition specified.
  - getRawProps
```
public ImmutableList<PropModel> getRawProps()
```
    Specified by:
    
    getRawProps in interface SpecModel
    
    Returns:
    
    the list of props without taking deduplication or name cache adjustments into account.
  - getProps
```
public ImmutableList<PropModel> getProps()
```
    Specified by:
    
    getProps in interface SpecModel
    
    Returns:
    
    the set of props that are defined by the spec.
  - getRawInjectProps
```
public ImmutableList<InjectPropModel> getRawInjectProps()
```
    Specified by:
    
    getRawInjectProps in interface SpecModel
    
    Returns:
    
    the list of injected props without name cache adjustments.
  - getInjectProps
```
public ImmutableList<InjectPropModel> getInjectProps()
```
    Specified by:
    
    getInjectProps in interface SpecModel
    
    Returns:
    
    the set of injected props that are defined by the spec.
  - getPropDefaults
```
public ImmutableList<PropDefaultModel> getPropDefaults()
```
    Specified by:
    
    getPropDefaults in interface SpecModel
    
    Returns:
    
    the set of prop defaults defined by the spec.
  - getTypeVariables
```
public ImmutableList<TypeVariableName> getTypeVariables()
```
    Specified by:
    
    getTypeVariables in interface SpecModel
    
    Returns:
    
    the type variables that are defined by the spec.
  - getStateValues
```
public ImmutableList<StateParamModel> getStateValues()
```
    Specified by:
    
    getStateValues in interface SpecModel
    
    Returns:
    
    the set of state values that are defined by the spec.
  - getCachedValues
```
public ImmutableList<CachedValueParamModel> getCachedValues()
```
    Specified by:
    
    getCachedValues in interface SpecModel
    
    Returns:
    
    the set of cached values that are defined by the spec.
  - getInterStageInputs
```
public ImmutableList<InterStageInputParamModel> getInterStageInputs()
```
    Specified by:
    
    getInterStageInputs in interface SpecModel
    
    Returns:
    
    the set of inter-stage inputs that are defined by the spec.
  - getTreeProps
```
public ImmutableList<TreePropModel> getTreeProps()
```
    Specified by:
    
    getTreeProps in interface SpecModel
    
    Returns:
    
    the set of tree props that are defined by the spec.
  - getEventDeclarations
```
public ImmutableList<EventDeclarationModel> getEventDeclarations()
```
    Specified by:
    
    getEventDeclarations in interface SpecModel
    
    Returns:
    
    the set of events that are defined by the spec.
  - getExtraBuilderMethods
```
public ImmutableList<BuilderMethodModel> getExtraBuilderMethods()
```
    Specified by:
    
    getExtraBuilderMethods in interface SpecModel
    
    Returns:
    
    the set of methods that are implicitly added to the builder.
  - getRenderDataDiffs
```
public ImmutableList<RenderDataDiffModel> getRenderDataDiffs()
```
    Specified by:
    
    getRenderDataDiffs in interface SpecModel
    
    Returns:
    
    the set of diff params used within lifecycle methods in the spec.
  - getClassAnnotations
```
public ImmutableList<AnnotationSpec> getClassAnnotations()
```
    Specified by:
    
    getClassAnnotations in interface SpecModel
    
    Returns:
    
    the set of annotations that should be added to the generated class.
  - getTags
```
public ImmutableList<TagModel> getTags()
```
    Specified by:
    
    getTags in interface SpecModel
    
    Returns:
    
    the set of empty interface tags that should be implemented by the generated class
  - getClassJavadoc
```
public String getClassJavadoc()
```
    Specified by:
    
    getClassJavadoc in interface SpecModel
    
    Returns:
    
    the javadoc for this spec.
  - getPropJavadocs
```
public ImmutableList<PropJavadocModel> getPropJavadocs()
```
    Specified by:
    
    getPropJavadocs in interface SpecModel
    
    Returns:
    
    the javadoc for the props defined by the spec.
  - isPublic
```
public boolean isPublic()
```
    Specified by:
    
    isPublic in interface SpecModel
    
    Returns:
    
    whether the generated class should be public or not.
  - getContextClass
```
public ClassName getContextClass()
```
    Specified by:
    
    getContextClass in interface SpecModel
    
    Returns:
    
    the ClassName of the context that is used in the generated class.
  - getComponentClass
```
public ClassName getComponentClass()
```
    Specified by:
    
    getComponentClass in interface SpecModel
    
    Returns:
    
    the ClassName of the component that is used in the generated class.
  - getStateContainerClass
```
public ClassName getStateContainerClass()
```
    Specified by:
    
    getStateContainerClass in interface SpecModel
    
    Returns:
    
    the ClassName of the state container class that is used in the generated class.
  - getTransitionClass
```
public ClassName getTransitionClass()
```
    Specified by:
    
    getTransitionClass in interface SpecModel
    
    Returns:
    
    the ClassName of the transition that is used in the generated class.
  - getTransitionContainerClass
```
public ClassName getTransitionContainerClass()
```
    Specified by:
    
    getTransitionContainerClass in interface SpecModel
    
    Returns:
    
    the ClassName of the transition container class that is used in the generated class.
  - getScopeMethodName
```
public String getScopeMethodName()
```
    Specified by:
    
    getScopeMethodName in interface SpecModel
    
    Returns:
    
    the scope method name on the Context class.
  - isStylingSupported
```
public boolean isStylingSupported()
```
    Specified by:
    
    isStylingSupported in interface SpecModel
    
    Returns:
    
    true if the generated class supports styling, false otherwise.
  - hasInjectedDependencies
```
public boolean hasInjectedDependencies()
```
    Specified by:
    
    hasInjectedDependencies in interface SpecModel
    
    Returns:
    
    whether this spec uses dependency injection.
  - shouldCheckIdInIsEquivalentToMethod
```
public boolean shouldCheckIdInIsEquivalentToMethod()
```
    Specified by:
    
    shouldCheckIdInIsEquivalentToMethod in interface SpecModel
    
    Returns:
    
    whether or not to check component id in isEquivalentTo() method.
  - hasDeepCopy
```
public boolean hasDeepCopy()
```
    Specified by:
    
    hasDeepCopy in interface SpecModel
    
    Returns:
    
    whether or not to deep copy this component.
  - shouldGenerateHasState
```
public boolean shouldGenerateHasState()
```
    Specified by:
    
    shouldGenerateHasState in interface SpecModel
    
    Returns:
    
    whether or not to generate a hasState method.
  - shouldGenerateCopyMethod
```
public boolean shouldGenerateCopyMethod()
```
    Specified by:
    
    shouldGenerateCopyMethod in interface SpecModel
    
    Returns:
    
    whether this spec requires deep copy and interstage copy methdods to be generated.
  - getDependencyInjectionHelper
```
public DependencyInjectionHelper getDependencyInjectionHelper()
```
    Specified by:
    
    getDependencyInjectionHelper in interface SpecModel
    
    Returns:
    
    null if this spec does not use dependency injection, otherwise return the generator that should be used to generate the correct methods for dependency injection to work for this component.
  - getSpecElementType
```
public SpecElementType getSpecElementType()
```
    Specified by:
    
    getSpecElementType in interface SpecModel
    
    Returns:
    
    The source type this spec is generated from, e.g. class or singleton.
  - getRepresentedObject
```
public Object getRepresentedObject()
```
    Specified by:
    
    getRepresentedObject in interface SpecModel
    
    Returns:
    
    the element that this model represents.
  - validate
```
public List<SpecModelValidationError> validate(EnumSet<RunMode> runMode)
```
    Specified by:
    
    validate in interface SpecModel
    
    Returns:
    
    a list of errors in the spec model. If the list is empty, then this model is valid.
  - generate
```
public TypeSpec generate(EnumSet<RunMode> runMode)
```
    Specified by:
    
    generate in interface SpecModel
    
    Returns:
    
    a TypeSpec representing the class that is generated by this model.
  - isPureRender
```
public boolean isPureRender()
```
    Description copied from interface: HasPureRender
    
    Whether this spec is pure render or not. If a spec is pure render then when the ComponentTree for this component is updated, if nothing changes then the measurements for this component can be re-used.
    
    Specified by:
    
    isPureRender in interface HasPureRender
  - shouldGenerateIsEquivalentTo
```
public boolean shouldGenerateIsEquivalentTo()
```
    Specified by:
    
    shouldGenerateIsEquivalentTo in interface SpecModel
    
    Returns:
    
    wether the isEquivalentTo() method should be generated or not. When not generated, the method ComponentUtils.hasEquivalentFields() will be used to check for equivalence through reflection.
  - getSimpleNameDelegate
```
public String getSimpleNameDelegate()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LayoutSpecModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LayoutSpecModel

Method Detail

getSpecName

getSpecTypeName

getComponentName

getComponentTypeName

getFields

getDelegateMethods

getEventMethods

getTriggerMethods

getWorkingRangeRegisterMethod

getWorkingRangeMethods

getUpdateStateMethods

getUpdateStateWithTransitionMethods

getRawProps

getProps

getRawInjectProps

getInjectProps

getPropDefaults

getTypeVariables

getStateValues

getCachedValues

getInterStageInputs

getTreeProps

getEventDeclarations

getExtraBuilderMethods

getRenderDataDiffs

getClassAnnotations

getTags

getClassJavadoc

getPropJavadocs

isPublic

getContextClass

getComponentClass

getStateContainerClass

getTransitionClass

getTransitionContainerClass

getScopeMethodName

isStylingSupported

hasInjectedDependencies

shouldCheckIdInIsEquivalentToMethod

hasDeepCopy

shouldGenerateHasState

shouldGenerateCopyMethod

getDependencyInjectionHelper

getSpecElementType

getRepresentedObject

validate

generate

isPureRender

shouldGenerateIsEquivalentTo

getSimpleNameDelegate

toString