com.facebook.buck.core.starlark.coercer

Class SkylarkParamInfo<T>

java.lang.Object

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

com.facebook.buck.core.starlark.coercer.SkylarkParamInfo<T>

All Implemented Interfaces:

ParamInfo<T>

public class SkylarkParamInfo<T>
extends AbstractParamInfo<T>

Represents a single field that can be represented in build files, backed by an Attribute. This is used to get/set user specified attributes on SkylarkDescriptionArg

Nested Class Summary

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

ParamInfo.Traversal

Constructor Summary

Constructors

Constructor and Description
SkylarkParamInfo(String name, Attribute<T> attr) Create an instance of SkylarkParamInfo

Method Summary

Modifier and Type	Method and Description
T	get(Object dto)
Attribute<?>	getAttr()
Hint	getHint()
Object	getImplicitPreCoercionValue()
boolean	isOptional()
void	setCoercedValue(Object dto, Object value) Set the param on dto to value, assuming value has already been coerced.

Methods inherited from class com.facebook.buck.rules.coercer.AbstractParamInfo

execConfiguration, getName, getPythonName, getResultClass, getTypeCoercer, hasElementTypes, isConfigurable, isDep, isInput, isTargetGraphOnlyDep, set, splitConfiguration, traverse

Methods inherited from class java.lang.Object

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

Constructor Detail

SkylarkParamInfo

public SkylarkParamInfo(String name,
                        Attribute<T> attr)

Create an instance of SkylarkParamInfo

Parameters:

name - the user facing name of this attribute

attr - the attribute used to get coercion information, constraints, etc for this param

Method Detail

getAttr

public Attribute<?> getAttr()

isOptional

public boolean isOptional()

Returns:

Whether the coerced type is Optional or not

getHint

@Nullable
public Hint getHint()

Returns:

A hint about the type of this param

getImplicitPreCoercionValue

@Nullable
public 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

public T get(Object dto)

Returns:

the value of this param as set on dto.

setCoercedValue

public void setCoercedValue(Object dto,
                            Object value)

Description copied from interface: ParamInfo

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

This is useful for things like making copies of dtos.