com.facebook.buck.rules.coercer

Interface ParamInfo<T>

All Known Implementing Classes:

AbstractParamInfo, ReflectionParamInfo, SkylarkParamInfo

public interface ParamInfo<T>

Represents a single field that can be represented in buck build files.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ParamInfo.Traversal Traversal interface used when coercing values

Method Summary

Modifier and Type	Method and Description
boolean	execConfiguration()
T	get(Object dto)
Hint	getHint()
Object	getImplicitPreCoercionValue()
String	getName()
String	getPythonName()
Class<?>	getResultClass()
TypeCoercer<?,T>	getTypeCoercer()
boolean	hasElementTypes(Class<?>... types)
boolean	isConfigurable()
boolean	isDep()
boolean	isInput()
boolean	isOptional()
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.
void	setCoercedValue(Object dto, Object value) Set the param on dto to value, assuming value has already been coerced.
boolean	splitConfiguration()
void	traverse(CellNameResolver cellPathResolver, ParamInfo.Traversal traversal, Object dto) Traverse the value of the field on dto that is represented by this instance.

Method Detail

getName

String getName()

Returns:

the user-facing name of this parameter

getTypeCoercer

TypeCoercer<?,T> getTypeCoercer()

Returns:

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

isOptional

boolean isOptional()

Returns:

Whether the coerced type is Optional or not

getPythonName

String getPythonName()

Returns:

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

isDep

boolean isDep()

Returns:

Whether or not this parameter is a dependency

isTargetGraphOnlyDep

boolean isTargetGraphOnlyDep()

See Also:

Hint.isTargetGraphOnlyDep()

isInput

boolean isInput()

See Also:

Hint.isConfigurable()

getHint

@Nullable
Hint getHint()

Returns:

A hint about the type of this param

isConfigurable

boolean isConfigurable()

Returns:

Whether this attribute is configurable or not

splitConfiguration

boolean splitConfiguration()

See Also:

Hint.splitConfiguration()

execConfiguration

boolean execConfiguration()

See Also:

Hint.execConfiguration()

getResultClass

Class<?> getResultClass()

Returns:

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

traverse

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

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.

Parameters:

cellPathResolver -

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)

getImplicitPreCoercionValue

@Nullable
Object getImplicitPreCoercionValue()

Returns:

The value for this parameter if it is an "implicit" attribute, otherwise null

This is used for parameters that have a default value and need to be accessed by users' rule implementations, but should not be set directly by users. e.g. underscore prefixed attributes in user defined rules. These values are pre-coercion and may be user provided. If this parameter is not an implicit parameter, this method should return null

get

T get(Object dto)

Returns:

the value of this param as set on dto.

set

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

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

Parameters:

cellNameResolver -

filesystem - ProjectFilesystem used to ensure Paths exist.

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

hostConfiguration -

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

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

setCoercedValue

void setCoercedValue(Object dto,
                     Object value)

Set the param on dto to value, assuming value has already been coerced.

This is useful for things like making copies of dtos.