SpecModel

All Known Implementing Classes:

DiffSectionSpecModel, GroupSectionSpecModel, LayoutSpecModel, MockSpecModel, MountSpecModel, SpecModelImpl, TestSpecModel
```
public interface SpecModel
```
A model that represents a ComponentSpec.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TypeSpec`	`generate(java.util.EnumSet<RunMode> runMode)`
`ImmutableList<CachedValueParamModel>`	`getCachedValues()`
`ImmutableList<AnnotationSpec>`	`getClassAnnotations()`
`java.lang.String`	`getClassJavadoc()`
`ClassName`	`getComponentClass()`
`java.lang.String`	`getComponentName()`
`TypeName`	`getComponentTypeName()`
`ClassName`	`getContextClass()`
`ImmutableList<SpecMethodModel<DelegateMethod,java.lang.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<PrepareInterStageInputParamModel>`	`getPrepareInterStageInputs()`
`ImmutableList<PropDefaultModel>`	`getPropDefaults()`
`ImmutableList<PropJavadocModel>`	`getPropJavadocs()`
`ImmutableList<PropModel>`	`getProps()`
`ImmutableList<InjectPropModel>`	`getRawInjectProps()`
`ImmutableList<PropModel>`	`getRawProps()`
`ImmutableList<RenderDataDiffModel>`	`getRenderDataDiffs()`
`java.lang.Object`	`getRepresentedObject()`
`java.lang.String`	`getScopeMethodName()`
`SpecElementType`	`getSpecElementType()`
`java.lang.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,java.lang.Void>>`	`getUpdateStateMethods()`
`ImmutableList<SpecMethodModel<UpdateStateMethod,java.lang.Void>>`	`getUpdateStateWithTransitionMethods()`
`ImmutableList<WorkingRangeMethodModel>`	`getWorkingRangeMethods()`
`SpecMethodModel<EventMethod,java.lang.Void>`	`getWorkingRangeRegisterMethod()`
`boolean`	`hasDeepCopy()`
`boolean`	`hasInjectedDependencies()`
`boolean`	`isPublic()`
`boolean`	`isStateful()`
`boolean`	`isStylingSupported()`
`boolean`	`shouldCheckIdInIsEquivalentToMethod()`
`boolean`	`shouldGenerateCopyMethod()`
`boolean`	`shouldGenerateHasState()`
`boolean`	`shouldGenerateIsEquivalentTo()`
`java.util.List<SpecModelValidationError>`	`validate(java.util.EnumSet<RunMode> runMode)`

- Method Detail
  - getSpecName
```
java.lang.String getSpecName()
```
    Returns:
    
    the name of the spec.
  - getSpecTypeName
```
ClassName getSpecTypeName()
```
    Returns:
    
    the TypeName representing the name of the Spec.
  - getComponentName
```
java.lang.String getComponentName()
```
    Returns:
    
    the name of the component that will be generated from this model.
  - getComponentTypeName
```
TypeName getComponentTypeName()
```
    Returns:
    
    the TypeName representing the name of the component that will be generated from this model.
  - getFields
```
ImmutableList<FieldModel> getFields()
```
    Returns:
    
    the list of fields defined in the spec.
  - getDelegateMethods
```
ImmutableList<SpecMethodModel<DelegateMethod,java.lang.Void>> getDelegateMethods()
```
    Returns:
    
    the list of methods defined in the spec which will be delegated to by the component that is generated from this model.
  - getEventMethods
```
ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> getEventMethods()
```
    Returns:
    
    the list of event methods defined by the spec.
  - getTriggerMethods
```
ImmutableList<SpecMethodModel<EventMethod,EventDeclarationModel>> getTriggerMethods()
```
    Returns:
    
    the list of trigger methods defined by the spec.
  - getWorkingRangeRegisterMethod
```
SpecMethodModel<EventMethod,java.lang.Void> getWorkingRangeRegisterMethod()
```
    Returns:
    
    the working range register method defined by the spec.
  - getWorkingRangeMethods
```
ImmutableList<WorkingRangeMethodModel> getWorkingRangeMethods()
```
    Returns:
    
    the list of working ranges methods defined by the spec.
  - getUpdateStateMethods
```
ImmutableList<SpecMethodModel<UpdateStateMethod,java.lang.Void>> getUpdateStateMethods()
```
    Returns:
    
    the list of methods defined in the spec for updating state.
  - getUpdateStateWithTransitionMethods
```
ImmutableList<SpecMethodModel<UpdateStateMethod,java.lang.Void>> getUpdateStateWithTransitionMethods()
```
    Returns:
    
    the list of methods defined in the spec for updating state with transition specified.
  - getRawProps
```
ImmutableList<PropModel> getRawProps()
```
    Returns:
    
    the list of props without taking deduplication or name cache adjustments into account.
  - getProps
```
ImmutableList<PropModel> getProps()
```
    Returns:
    
    the set of props that are defined by the spec.
  - getRawInjectProps
```
ImmutableList<InjectPropModel> getRawInjectProps()
```
    Returns:
    
    the list of injected props without name cache adjustments.
  - getInjectProps
```
ImmutableList<InjectPropModel> getInjectProps()
```
    Returns:
    
    the set of injected props that are defined by the spec.
  - getPropDefaults
```
ImmutableList<PropDefaultModel> getPropDefaults()
```
    Returns:
    
    the set of prop defaults defined by the spec.
  - getTypeVariables
```
ImmutableList<TypeVariableName> getTypeVariables()
```
    Returns:
    
    the type variables that are defined by the spec.
  - getStateValues
```
ImmutableList<StateParamModel> getStateValues()
```
    Returns:
    
    the set of state values that are defined by the spec.
  - getCachedValues
```
ImmutableList<CachedValueParamModel> getCachedValues()
```
    Returns:
    
    the set of cached values that are defined by the spec.
  - getInterStageInputs
```
ImmutableList<InterStageInputParamModel> getInterStageInputs()
```
    Returns:
    
    the set of inter-stage inputs that are defined by the spec.
  - getPrepareInterStageInputs
```
ImmutableList<PrepareInterStageInputParamModel> getPrepareInterStageInputs()
```
    Returns:
    
    the set of inter-stage inputs that are defined by the spec.
  - getTreeProps
```
ImmutableList<TreePropModel> getTreeProps()
```
    Returns:
    
    the set of tree props that are defined by the spec.
  - getEventDeclarations
```
ImmutableList<EventDeclarationModel> getEventDeclarations()
```
    Returns:
    
    the set of events that are defined by the spec.
  - getExtraBuilderMethods
```
ImmutableList<BuilderMethodModel> getExtraBuilderMethods()
```
    Returns:
    
    the set of methods that are implicitly added to the builder.
  - getRenderDataDiffs
```
ImmutableList<RenderDataDiffModel> getRenderDataDiffs()
```
    Returns:
    
    the set of diff params used within lifecycle methods in the spec.
  - getClassAnnotations
```
ImmutableList<AnnotationSpec> getClassAnnotations()
```
    Returns:
    
    the set of annotations that should be added to the generated class.
  - getTags
```
ImmutableList<TagModel> getTags()
```
    Returns:
    
    the set of empty interface tags that should be implemented by the generated class
  - getClassJavadoc
```
java.lang.String getClassJavadoc()
```
    Returns:
    
    the javadoc for this spec.
  - getPropJavadocs
```
ImmutableList<PropJavadocModel> getPropJavadocs()
```
    Returns:
    
    the javadoc for the props defined by the spec.
  - isPublic
```
boolean isPublic()
```
    Returns:
    
    whether the generated class should be public or not.
  - getContextClass
```
ClassName getContextClass()
```
    Returns:
    
    the ClassName of the context that is used in the generated class.
  - getComponentClass
```
ClassName getComponentClass()
```
    Returns:
    
    the ClassName of the component that is used in the generated class.
  - getStateContainerClass
```
ClassName getStateContainerClass()
```
    Returns:
    
    the ClassName of the state container class that is used in the generated class.
  - getTransitionClass
```
ClassName getTransitionClass()
```
    Returns:
    
    the ClassName of the transition that is used in the generated class.
  - getTransitionContainerClass
```
ClassName getTransitionContainerClass()
```
    Returns:
    
    the ClassName of the transition container class that is used in the generated class.
  - getScopeMethodName
```
java.lang.String getScopeMethodName()
```
    Returns:
    
    the scope method name on the Context class.
  - isStylingSupported
```
boolean isStylingSupported()
```
    Returns:
    
    true if the generated class supports styling, false otherwise.
  - hasInjectedDependencies
```
boolean hasInjectedDependencies()
```
    Returns:
    
    whether this spec uses dependency injection.
  - shouldCheckIdInIsEquivalentToMethod
```
boolean shouldCheckIdInIsEquivalentToMethod()
```
    Returns:
    
    whether or not to check component id in isEquivalentTo() method.
  - hasDeepCopy
```
boolean hasDeepCopy()
```
    Returns:
    
    whether or not to deep copy this component.
  - shouldGenerateHasState
```
boolean shouldGenerateHasState()
```
    Returns:
    
    whether or not to generate a hasState method.
  - isStateful
```
boolean isStateful()
```
    Returns:
    
    whether or not this component is stateful.
  - getDependencyInjectionHelper
```
DependencyInjectionHelper getDependencyInjectionHelper()
```
    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
```
SpecElementType getSpecElementType()
```
    Returns:
    
    The source type this spec is generated from, e.g. class or singleton.
  - getRepresentedObject
```
java.lang.Object getRepresentedObject()
```
    Returns:
    
    the element that this model represents.
  - validate
```
java.util.List<SpecModelValidationError> validate(java.util.EnumSet<RunMode> runMode)
```
    Parameters:
    
    runMode -
    
    Returns:
    
    a list of errors in the spec model. If the list is empty, then this model is valid.
  - generate
```
TypeSpec generate(java.util.EnumSet<RunMode> runMode)
```
    Returns:
    
    a TypeSpec representing the class that is generated by this model.
  - shouldGenerateCopyMethod
```
boolean shouldGenerateCopyMethod()
```
    Returns:
    
    whether this spec requires deep copy and interstage copy methdods to be generated.
  - shouldGenerateIsEquivalentTo
```
boolean shouldGenerateIsEquivalentTo()
```
    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.

Interface SpecModel

Method Summary

Method Detail

getSpecName

getSpecTypeName

getComponentName

getComponentTypeName

getFields

getDelegateMethods

getEventMethods

getTriggerMethods

getWorkingRangeRegisterMethod

getWorkingRangeMethods

getUpdateStateMethods

getUpdateStateWithTransitionMethods

getRawProps

getProps

getRawInjectProps

getInjectProps

getPropDefaults

getTypeVariables

getStateValues

getCachedValues

getInterStageInputs

getPrepareInterStageInputs

getTreeProps

getEventDeclarations

getExtraBuilderMethods

getRenderDataDiffs

getClassAnnotations

getTags

getClassJavadoc

getPropJavadocs

isPublic

getContextClass

getComponentClass

getStateContainerClass

getTransitionClass

getTransitionContainerClass

getScopeMethodName

isStylingSupported

hasInjectedDependencies

shouldCheckIdInIsEquivalentToMethod

hasDeepCopy

shouldGenerateHasState

isStateful

getDependencyInjectionHelper

getSpecElementType

getRepresentedObject

validate

generate

shouldGenerateCopyMethod

shouldGenerateIsEquivalentTo