com.facebook.buck.core.model

Class UnconfiguredBuildTarget

java.lang.Object

com.facebook.buck.core.model.UnconfiguredBuildTarget

All Implemented Interfaces:

DependencyStack.Element, DependencyStack.ProvidesElement, QueryTarget, Comparable<UnconfiguredBuildTarget>

public class UnconfiguredBuildTarget
extends Object
implements Comparable<UnconfiguredBuildTarget>, QueryTarget, DependencyStack.Element

Data object that holds properties to uniquely identify a build target with flavors

In other words, this represents a parsed representation of a build target with flavors but without configuration.

For example, a fully qualified target name like `cell//path/to:target#flavor1,flavor2` parses `cell` as a cell name, `//path/to` as a base name that corresponds to the real path to the build file that contains a target, `target` is a target name found in that build file and `flavor1` and 'flavor2' as flavors as applied to this build target.

Flavors are a legacy way to configure a build target so it can mutate its behavior based on user-provided input or client settings, like target or running platforms. Flavors should not be used anymore, instead you want to use a BuildTarget along with passed TargetConfiguration.

Method Summary

Modifier and Type	Method and Description
UnconfiguredBuildTarget	assertUnflavored() Verifies that this build target has no flavors.
int	compareTo(UnconfiguredBuildTarget that)
BuildTarget	configure(TargetConfiguration targetConfiguration)
boolean	equals(Object o)
BaseName	getBaseName()
CanonicalCellName	getCell() Name of the cell that current build target belongs to
CellRelativePath	getCellRelativeBasePath() Typed version of getBaseName().
String	getCellRelativeName()
DependencyStack.Element	getElement()
FlavorSet	getFlavors()
com.google.common.collect.ImmutableSortedSet<Flavor>	getFlavorSet() Set of flavors used with that build target.
String	getFullyQualifiedName() Fully qualified name of unconfigured build target, for example cell//some/target:name#flavor1,flavor2
String	getName() Name of the build target, i.e.
String	getShortNameAndFlavorPostfix()
UnflavoredBuildTarget	getUnflavoredBuildTarget()
int	hashCode()
boolean	isFlavored()
static UnconfiguredBuildTarget	of(BaseName baseName, String shortName) Helper for creating a build target in the root cell with no flavors.
static UnconfiguredBuildTarget	of(CanonicalCellName cell, BaseName baseName, String name, FlavorSet flavors) A constructor
static UnconfiguredBuildTarget	of(UnflavoredBuildTarget unflavoredBuildTarget, FlavorSet flavors) A constructor
String	toString()
UnconfiguredBuildTarget	withFlavors(Flavor... flavors) Creates a new build target by copying all of the information from this build target and using the provided flavors as flavors in the new build target.
UnconfiguredBuildTarget	withFlavors(Iterable<? extends Flavor> flavors) Creates a new build target by copying all of the information from this build target and using the provided flavors as flavors in the new build target.
UnconfiguredBuildTarget	withLocalName(String localName)
UnconfiguredBuildTarget	withoutFlavors()
UnconfiguredBuildTarget	withShortName(String shortName) Creates a new build target by copying all of the information from this build target and replacing the short name with the given name.
UnconfiguredBuildTarget	withUnflavoredBuildTarget(UnflavoredBuildTarget target)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.model.QueryTarget

compare

Method Detail

getUnflavoredBuildTarget

public UnflavoredBuildTarget getUnflavoredBuildTarget()

getCell

public CanonicalCellName getCell()

Name of the cell that current build target belongs to

getBaseName

public BaseName getBaseName()

getCellRelativeBasePath

public CellRelativePath getCellRelativeBasePath()

Typed version of getBaseName().

getName

public String getName()

Name of the build target, i.e. part of fully qualified name after the colon If this build target were cell_name//third_party/java/guava:guava-latest, then this would return "guava-latest"

getFlavorSet

public com.google.common.collect.ImmutableSortedSet<Flavor> getFlavorSet()

Set of flavors used with that build target.

getFlavors

public FlavorSet getFlavors()

getFullyQualifiedName

public String getFullyQualifiedName()

Fully qualified name of unconfigured build target, for example cell//some/target:name#flavor1,flavor2

getShortNameAndFlavorPostfix

public String getShortNameAndFlavorPostfix()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(UnconfiguredBuildTarget that)

Specified by:

compareTo in interface Comparable<UnconfiguredBuildTarget>

getCellRelativeName

public String getCellRelativeName()

getElement

public DependencyStack.Element getElement()

Specified by:

getElement in interface DependencyStack.Element

Specified by:

getElement in interface DependencyStack.ProvidesElement

of

public static UnconfiguredBuildTarget of(UnflavoredBuildTarget unflavoredBuildTarget,
                                         FlavorSet flavors)

A constructor

of

public static UnconfiguredBuildTarget of(CanonicalCellName cell,
                                         BaseName baseName,
                                         String name,
                                         FlavorSet flavors)

A constructor

of

public static UnconfiguredBuildTarget of(BaseName baseName,
                                         String shortName)

Helper for creating a build target in the root cell with no flavors.

withoutFlavors

public UnconfiguredBuildTarget withoutFlavors()

withLocalName

public UnconfiguredBuildTarget withLocalName(String localName)

configure

public BuildTarget configure(TargetConfiguration targetConfiguration)

isFlavored

public boolean isFlavored()

withFlavors

public UnconfiguredBuildTarget withFlavors(Iterable<? extends Flavor> flavors)

Creates a new build target by copying all of the information from this build target and using the provided flavors as flavors in the new build target.

Parameters:

flavors - flavors to use when creating a new build target

withFlavors

public UnconfiguredBuildTarget withFlavors(Flavor... flavors)

Creates a new build target by copying all of the information from this build target and using the provided flavors as flavors in the new build target.

Parameters:

flavors - flavors to use when creating a new build target

withShortName

public UnconfiguredBuildTarget withShortName(String shortName)

Creates a new build target by copying all of the information from this build target and replacing the short name with the given name.

Parameters:

shortName - short name of the new build target

withUnflavoredBuildTarget

public UnconfiguredBuildTarget withUnflavoredBuildTarget(UnflavoredBuildTarget target)

assertUnflavored

public UnconfiguredBuildTarget assertUnflavored()

Verifies that this build target has no flavors.

Returns:

this build target

Throws:

IllegalStateException - if a build target has flavors