com.facebook.litho.specmodels.model

Class DelegateMethodDescription

java.lang.Object

com.facebook.litho.specmodels.model.DelegateMethodDescription

public final class DelegateMethodDescription
extends java.lang.Object

Describes the signature and other feature of a delegate method.

We use method descriptions to refer to abstract methods defined in com.facebook.litho.Component, so that we can define implementations that delegate to client-declared methods with annotated props.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DelegateMethodDescription.Builder
static class	DelegateMethodDescription.InterStagePropsTarget
static class	DelegateMethodDescription.OptionalParameterType Defines possible param types that can be used in delegate methods.

Field Summary

Fields

Modifier and Type	Field and Description
javax.lang.model.element.Modifier	accessType
ImmutableList<AnnotationSpec>	annotations
boolean	createsLegacyState
ImmutableList<TypeName>	exceptions
ImmutableList<MethodSpec>	extraMethods
ImmutableList<java.lang.Class<? extends java.lang.annotation.Annotation>>	interStageInputAnnotations
ImmutableList<LifecycleMethodArgumentType>	lifecycleMethodArgumentTypes
DelegateMethodDescription.InterStagePropsTarget	mInterStagePropsTarget
java.lang.String	name
ImmutableList<MethodParamModel>	optionalParameters
ImmutableList<DelegateMethodDescription.OptionalParameterType>	optionalParameterTypes
TypeName	returnType

Method Summary

Modifier and Type	Method and Description
ImmutableList<TypeName>	allowedDelegateMethodArguments()
static DelegateMethodDescription.Builder	fromDelegateMethodDescription(DelegateMethodDescription methodDescription)
static boolean	isAllowedTypeAndConsume(MethodParamModel arg, java.util.Queue<TypeName> types) This utility searches for the first lifecycle argument used by the delegate method, and consumes it.
static boolean	isArgumentTypeAllowed(MethodParamModel arg, ImmutableList<TypeName> types) Checks if any allowed argument type matches the delegate method param.
static boolean	isArgumentTypeAllowed(MethodParamModel arg, TypeName expected) Checks if the argument type matches the delegate method param.
static DelegateMethodDescription.Builder	newBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

annotations

public final ImmutableList<AnnotationSpec> annotations

accessType

public final javax.lang.model.element.Modifier accessType

returnType

public final TypeName returnType

name

public final java.lang.String name

lifecycleMethodArgumentTypes

public final ImmutableList<LifecycleMethodArgumentType> lifecycleMethodArgumentTypes

optionalParameters

public final ImmutableList<MethodParamModel> optionalParameters

optionalParameterTypes

public final ImmutableList<DelegateMethodDescription.OptionalParameterType> optionalParameterTypes

interStageInputAnnotations

public final ImmutableList<java.lang.Class<? extends java.lang.annotation.Annotation>> interStageInputAnnotations

mInterStagePropsTarget

public final DelegateMethodDescription.InterStagePropsTarget mInterStagePropsTarget

extraMethods

public final ImmutableList<MethodSpec> extraMethods

exceptions

public final ImmutableList<TypeName> exceptions

createsLegacyState

public final boolean createsLegacyState

Method Detail

allowedDelegateMethodArguments

public ImmutableList<TypeName> allowedDelegateMethodArguments()

newBuilder

public static DelegateMethodDescription.Builder newBuilder()

fromDelegateMethodDescription

public static DelegateMethodDescription.Builder fromDelegateMethodDescription(DelegateMethodDescription methodDescription)

isAllowedTypeAndConsume

public static boolean isAllowedTypeAndConsume(MethodParamModel arg,
                                              java.util.Queue<TypeName> types)

This utility searches for the first lifecycle argument used by the delegate method, and consumes it. Every unmatched type encountered before that is removed from the queue since the order of arguments needs to be maintained.

isArgumentTypeAllowed

public static boolean isArgumentTypeAllowed(MethodParamModel arg,
                                            ImmutableList<TypeName> types)

Checks if any allowed argument type matches the delegate method param.

isArgumentTypeAllowed

public static boolean isArgumentTypeAllowed(MethodParamModel arg,
                                            TypeName expected)

Checks if the argument type matches the delegate method param.