com.facebook.buck.core.description.arg

Annotation Type Hint

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface Hint

Represents hints given when deal with the value of a type returned by BaseDescription.getConstructorArgType().

Field Summary

Fields

Modifier and Type	Fields and Description
static boolean	DEFAULT_EXEC_CONFIGURATION
static boolean	DEFAULT_IS_CONFIGURABLE
static boolean	DEFAULT_IS_DEP
static boolean	DEFAULT_IS_INPUT
static boolean	DEFAULT_IS_TARGET_GRAPH_ONLY_DEP
static boolean	DEFAULT_SPLIT_CONFIGURATION

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	execConfiguration Indicates that execution configuration (as opposed to target configuration) should be used when resolving targets.
boolean	isConfigurable
boolean	isDep
boolean	isInput
boolean	isTargetGraphOnlyDep
boolean	splitConfiguration Indicates that target configuration needs to be split.

Field Detail

DEFAULT_IS_DEP

public static final boolean DEFAULT_IS_DEP

DEFAULT_IS_INPUT

public static final boolean DEFAULT_IS_INPUT

DEFAULT_IS_TARGET_GRAPH_ONLY_DEP

public static final boolean DEFAULT_IS_TARGET_GRAPH_ONLY_DEP

DEFAULT_IS_CONFIGURABLE

public static final boolean DEFAULT_IS_CONFIGURABLE

DEFAULT_SPLIT_CONFIGURATION

public static final boolean DEFAULT_SPLIT_CONFIGURATION

DEFAULT_EXEC_CONFIGURATION

public static final boolean DEFAULT_EXEC_CONFIGURATION

Element Detail

isDep

public abstract boolean isDep

Returns:

Whether to search the field's value for dependencies

Default:

true

isInput

public abstract boolean isInput

Returns:

Whether to use the field's value as an input

Default:

true

isTargetGraphOnlyDep

public abstract boolean isTargetGraphOnlyDep

Returns:

Whether to add the field's value to the target graph, but do not automatically propagate it to the build rule (action graph). During action graph construction, build rules can still decide to add them to action graph based on some condition. Build rules must explicitly handle these dependencies if they should be used during build.

For example, rules that support platform-specific dependencies must explicitly include dependencies matching target platform into the action graph.

Default:

false

isConfigurable

public abstract boolean isConfigurable

Returns:

Whether an attribute can be configured using select.

Default:

true

splitConfiguration

public abstract boolean splitConfiguration

Indicates that target configuration needs to be split.

The target configuration will be transformed into multiple other configurations and every target in this attribute (target-based object) will be created for every configuration and the resulting list will be stored in this attribute.

Note that this logic only applies when target configuration supports transformation into multiple configurations and the attribute type supports concatenation.

Default:

false

execConfiguration

public abstract boolean execConfiguration

Indicates that execution configuration (as opposed to target configuration) should be used when resolving targets.

This is used for example in cxx_toolchain rule: toolchain itself need to be created with target configuration, but if it specifies c compiler as a build target, that target need to be built for execution configuration.

Default:

false