com.facebook.buck.parser.spec

Class BuildTargetSpec

java.lang.Object

com.facebook.buck.parser.spec.BuildTargetSpec

All Implemented Interfaces:

TargetNodeSpec

public abstract class BuildTargetSpec
extends Object
implements TargetNodeSpec

Matches a TargetNode that corresponds to a single build target

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.parser.spec.TargetNodeSpec

TargetNodeSpec.TargetType

Constructor Summary

Constructors

Constructor and Description
BuildTargetSpec()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<BuildTarget,TargetNodeMaybeIncompatible>	filter(Iterable<TargetNodeMaybeIncompatible> nodes)
static BuildTargetSpec	from(UnconfiguredBuildTarget target) Create new instance of BuildTargetSpec and automatically resolve BuildFileSpec based on UnconfiguredBuildTarget properties.
static BuildTargetSpec	from(UnconfiguredBuildTargetWithOutputs targetWithOutputs) Returns a new instance of BuildTargetSpec and automatically resolve BuildFileSpec based on UnconfiguredBuildTarget properties.
abstract BuildFileSpec	getBuildFileSpec()
BuildTargetPattern	getBuildTargetPattern(Cell cell) Convert from a legacy TargetNodeSpec to a new-hotness BuildTargetPattern.
TargetNodeSpec.TargetType	getTargetType()
UnconfiguredBuildTarget	getUnconfiguredBuildTarget()
abstract UnconfiguredBuildTargetWithOutputs	getUnconfiguredBuildTargetViewWithOutputs()
static BuildTargetSpec	of(UnconfiguredBuildTarget unconfiguredBuildTarget, BuildFileSpec buildFileSpec) Returns a BuildTargetSpec with an empty output label.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildTargetSpec

public BuildTargetSpec()

Method Detail

getUnconfiguredBuildTargetViewWithOutputs

public abstract UnconfiguredBuildTargetWithOutputs getUnconfiguredBuildTargetViewWithOutputs()

Returns:

Build target to match with this spec and its output label, if any

getUnconfiguredBuildTarget

public UnconfiguredBuildTarget getUnconfiguredBuildTarget()

of

public static BuildTargetSpec of(UnconfiguredBuildTarget unconfiguredBuildTarget,
                                 BuildFileSpec buildFileSpec)

Returns a BuildTargetSpec with an empty output label.

getBuildFileSpec

public abstract BuildFileSpec getBuildFileSpec()

Specified by:

getBuildFileSpec in interface TargetNodeSpec

Returns:

a BuildFileSpec representing the build files to parse to search for specific build target.

from

public static BuildTargetSpec from(UnconfiguredBuildTargetWithOutputs targetWithOutputs)

Returns a new instance of BuildTargetSpec and automatically resolve BuildFileSpec based on UnconfiguredBuildTarget properties. The returned BuildTargetSpec may carry a non-empty output label through UnconfiguredBuildTargetWithOutputs.

Parameters:

targetWithOutputs - Build target to match

from

public static BuildTargetSpec from(UnconfiguredBuildTarget target)

Create new instance of BuildTargetSpec and automatically resolve BuildFileSpec based on UnconfiguredBuildTarget properties. The returned BuildTargetSpec carries an empty output label.

Parameters:

target - Build target to match

getTargetType

public TargetNodeSpec.TargetType getTargetType()

Specified by:

getTargetType in interface TargetNodeSpec

Returns:

whether spec is a single target requested by a name or a list of targets requested with recursive spec (i.e. ... )

filter

public com.google.common.collect.ImmutableMap<BuildTarget,TargetNodeMaybeIncompatible> filter(Iterable<TargetNodeMaybeIncompatible> nodes)

Specified by:

filter in interface TargetNodeSpec

Returns:

the targets which should be built according to this spec

getBuildTargetPattern

public BuildTargetPattern getBuildTargetPattern(Cell cell)

Description copied from interface: TargetNodeSpec

Convert from a legacy TargetNodeSpec to a new-hotness BuildTargetPattern.

This conversion is imperfect and best-effort. If possible, use BuildTargetPatternParser.parse(String, CellNameResolver) to create a BuildTargetPattern instead.

This conversion is lossy. Some attributes, such as whether test targets should be included, are not reflected in the result.

Specified by:

getBuildTargetPattern in interface TargetNodeSpec

Parameters:

cell - this TargetNodeSpec's cell. Some implementations of TargetNodeSpec do not store a cell name, so cell provides the name.

Returns:

a pattern matching the same targets as this pattern.

toString

public String toString()

Overrides:

toString in class Object