com.facebook.buck.rules.coercer

Class AbstractParamInfo<T>

java.lang.Object

com.facebook.buck.rules.coercer.AbstractParamInfo<T>

All Implemented Interfaces:

ParamInfo<T>

Direct Known Subclasses:

ReflectionParamInfo, SkylarkParamInfo

public abstract class AbstractParamInfo<T>
extends Object
implements ParamInfo<T>

Represents a single field that can be represented in buck build files. This base class implements some common logic that is used by both all subclasses

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.rules.coercer.ParamInfo

ParamInfo.Traversal

Constructor Summary

Constructors

Constructor and Description
AbstractParamInfo(String name, TypeCoercer<?,T> typeCoercer) Create an instance of AbstractParamInfo

Method Summary

Modifier and Type	Method and Description
boolean	execConfiguration()
String	getName()
String	getPythonName()
Class<?>	getResultClass()
TypeCoercer<?,T>	getTypeCoercer()
boolean	hasElementTypes(Class<?>... types)
boolean	isConfigurable()
boolean	isDep()
boolean	isInput()
boolean	isTargetGraphOnlyDep()
void	set(CellNameResolver cellNameResolver, ProjectFilesystem filesystem, ForwardRelativePath pathRelativeToProjectRoot, TargetConfiguration targetConfiguration, TargetConfiguration hostConfiguration, Object dto, Object value) Sets a single property of the dto, coercing types as necessary.
boolean	splitConfiguration()
void	traverse(CellNameResolver cellNameResolver, ParamInfo.Traversal traversal, Object dto) Traverse the value of the field on dto that is represented by this instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.rules.coercer.ParamInfo

get, getHint, getImplicitPreCoercionValue, isOptional, setCoercedValue

Constructor Detail

AbstractParamInfo

public AbstractParamInfo(String name,
                         TypeCoercer<?,T> typeCoercer)

Create an instance of AbstractParamInfo

Method Detail

getName

public String getName()

Specified by:

getName in interface ParamInfo<T>

Returns:

the user-facing name of this parameter

getTypeCoercer

public TypeCoercer<?,T> getTypeCoercer()

Specified by:

getTypeCoercer in interface ParamInfo<T>

Returns:

the TypeCoercer that converts raw values to the correct type for this param

getPythonName

public String getPythonName()

Specified by:

getPythonName in interface ParamInfo<T>

Returns:

the python-friendly (snake case) name for this param

isDep

public boolean isDep()

Specified by:

isDep in interface ParamInfo<T>

Returns:

Whether or not this parameter is a dependency

isTargetGraphOnlyDep

public boolean isTargetGraphOnlyDep()

Specified by:

isTargetGraphOnlyDep in interface ParamInfo<T>

See Also:

Hint.isTargetGraphOnlyDep()

isInput

public boolean isInput()

Specified by:

isInput in interface ParamInfo<T>

See Also:

Hint.isConfigurable()

isConfigurable

public boolean isConfigurable()

Specified by:

isConfigurable in interface ParamInfo<T>

Returns:

Whether this attribute is configurable or not

splitConfiguration

public boolean splitConfiguration()

Specified by:

splitConfiguration in interface ParamInfo<T>

See Also:

Hint.splitConfiguration()

execConfiguration

public boolean execConfiguration()

Specified by:

execConfiguration in interface ParamInfo<T>

See Also:

Hint.execConfiguration()

getResultClass

public Class<?> getResultClass()

Specified by:

getResultClass in interface ParamInfo<T>

Returns:

the type that input values will be coerced to. Return the type parameter of Optional if wrapped in Optional.

traverse

public void traverse(CellNameResolver cellNameResolver,
                     ParamInfo.Traversal traversal,
                     Object dto)

Description copied from interface: ParamInfo

Traverse the value of the field on dto that is represented by this instance.

If this field has a top level Optional type, traversal begins at the Optional value, or not at all if the field is empty.

Specified by:

traverse in interface ParamInfo<T>

traversal - traversal to apply on the values.

dto - the object whose field will be traversed.

See Also:

TypeCoercer.traverse(com.facebook.buck.core.cell.nameresolver.CellNameResolver, Object, TypeCoercer.Traversal)

set

public void set(CellNameResolver cellNameResolver,
                ProjectFilesystem filesystem,
                ForwardRelativePath pathRelativeToProjectRoot,
                TargetConfiguration targetConfiguration,
                TargetConfiguration hostConfiguration,
                Object dto,
                @Nullable
                Object value)
         throws ParamInfoException

Description copied from interface: ParamInfo

Sets a single property of the dto, coercing types as necessary.

Specified by:

set in interface ParamInfo<T>

filesystem - ProjectFilesystem used to ensure Paths exist.

pathRelativeToProjectRoot - The path relative to the project root that this DTO is for.

dto - The constructor DTO on which the value should be set.

value - The value, which may be coerced depending on the type on dto.

Throws:

ParamInfoException

hasElementTypes

public boolean hasElementTypes(Class<?>... types)

Specified by:

hasElementTypes in interface ParamInfo<T>