com.facebook.buck.parser.function

Class BuckPyFunction

java.lang.Object

com.facebook.buck.parser.function.BuckPyFunction

public class BuckPyFunction
extends Object

Used to generate a function for use within buck.py for the rule described by a Description.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCK_PY_FUNCTION_TEMPLATE
static String	INTERNAL_PROPERTY_NAME_PREFIX Properties from the JSON produced by buck.py that start with this prefix do not correspond to build rule arguments specified by the user.
static String	TYPE_PROPERTY_NAME The name of the property in the JSON produced by buck.py that identifies the type of the build rule being defined.

Constructor Summary

Constructors

Constructor and Description
BuckPyFunction(TypeCoercerFactory typeCoercerFactory)

Method Summary

Modifier and Type	Method and Description
String	addDefaultAttributes() Returns a python string containing all of the default rule parameters that should be made available to user defined rules in the python build file parser
String	toPythonFunction(RuleType type, Class<? extends DataTransferObject> dtoClass) Create a Python function definition for given rule type and parameters described by DTO type.

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_PROPERTY_NAME_PREFIX

public static final String INTERNAL_PROPERTY_NAME_PREFIX

Properties from the JSON produced by buck.py that start with this prefix do not correspond to build rule arguments specified by the user. Instead, they contain internal-only metadata, so they should not be printed when the build rule is reproduced.

See Also:

Constant Field Values

TYPE_PROPERTY_NAME

public static final String TYPE_PROPERTY_NAME

The name of the property in the JSON produced by buck.py that identifies the type of the build rule being defined.

See Also:

Constant Field Values

BUCK_PY_FUNCTION_TEMPLATE

public static final String BUCK_PY_FUNCTION_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

BuckPyFunction

public BuckPyFunction(TypeCoercerFactory typeCoercerFactory)

Method Detail

toPythonFunction

public String toPythonFunction(RuleType type,
                               Class<? extends DataTransferObject> dtoClass)

Create a Python function definition for given rule type and parameters described by DTO type.

addDefaultAttributes

public String addDefaultAttributes()

Returns a python string containing all of the default rule parameters that should be made available to user defined rules in the python build file parser