com.facebook.buck.core.model.targetgraph.impl

Class TargetNodeImpl<T extends ConstructorArg>

java.lang.Object

com.facebook.buck.core.model.targetgraph.impl.TargetNodeImpl<T>

All Implemented Interfaces:

DependencyStack.ProvidesElement, ComputeResult, HasBuildTarget, TargetNode<T>, ObeysVisibility, Comparable<TargetNode<?>>

public abstract class TargetNodeImpl<T extends ConstructorArg>
extends Object
implements TargetNode<T>

A TargetNode represents a node in the target graph which is created by the Parser as a result of parsing BUCK files in a project. It is responsible for processing the raw (python) inputs of a build rule, and gathering any build targets and paths referenced from those inputs.

Constructor Summary

Constructors

Constructor and Description
TargetNodeImpl()

Method Summary

Modifier and Type	Method and Description
protected void	check()
int	compareTo(TargetNode<?> o)
TargetNode<T>	copyWithFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors) This method copies this target node with applying logic in ImplicitDepsInferringDescription that may give different results for deps based on flavors.
Set<BuildTarget>	getBuildDeps()
abstract BuildTarget	getBuildTarget()
abstract com.google.common.collect.ImmutableSortedSet<BuildTarget>	getConfigurationDeps() Provides a set of configuration targets that were used during the construction of this node.
abstract T	getConstructorArg()
abstract com.google.common.collect.ImmutableSet<BuildTarget>	getDeclaredDeps()
abstract BaseDescription<T>	getDescription()
abstract com.google.common.collect.ImmutableSortedSet<BuildTarget>	getExtraDeps()
abstract ProjectFilesystem	getFilesystem()
abstract com.google.common.collect.ImmutableSet<ForwardRelativePath>	getInputs() Cell root-relative paths.
abstract NodeCopier	getNodeCopier()
Set<BuildTarget>	getParseDeps()
RuleType	getRuleType()
abstract Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>>	getSelectedVersions()
abstract com.google.common.collect.ImmutableSortedSet<BuildTarget>	getTargetGraphOnlyDeps() BuildTargetPaths which, when changed, may change the BuildRules produced by this TargetNode, but whose steps don't need executing in order to build this TargetNode's BuildRules.
Set<BuildTarget>	getTotalDeps() Dependencies that include build targets as well as configuration targets that this node depends on.
VisibilityChecker	getVisibilityChecker()
abstract com.google.common.collect.ImmutableSet<VisibilityPattern>	getVisibilityPatterns()
abstract com.google.common.collect.ImmutableSet<VisibilityPattern>	getWithinViewPatterns()
boolean	isVisibleTo(TargetNode<?> viewer)
void	isVisibleToOrThrow(TargetNode<?> viewer)
static <T extends ConstructorArg> TargetNodeImpl<T>	of(BuildTarget buildTarget, NodeCopier nodeCopier, BaseDescription<T> description, T constructorArg, ProjectFilesystem filesystem, com.google.common.collect.ImmutableSet<ForwardRelativePath> inputs, com.google.common.collect.ImmutableSet<BuildTarget> declaredDeps, com.google.common.collect.ImmutableSortedSet<BuildTarget> extraDeps, com.google.common.collect.ImmutableSortedSet<BuildTarget> targetGraphOnlyDeps, com.google.common.collect.ImmutableSortedSet<BuildTarget> configurationDeps, com.google.common.collect.ImmutableSet<VisibilityPattern> visibilityPatterns, com.google.common.collect.ImmutableSet<VisibilityPattern> withinViewPatterns, Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions)
String	toString()
TargetNodeImpl<T>	withBuildTarget(BuildTarget buildTarget)
TargetNodeImpl<T>	withConstructorArg(T constructorArg)
TargetNodeImpl<T>	withDeclaredDeps(Iterable<? extends BuildTarget> declaredDeps)
TargetNodeImpl<T>	withExtraDeps(com.google.common.collect.ImmutableSortedSet<BuildTarget> extraDeps)
TargetNodeImpl<T>	withFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors) This method copies this target node without applying logic in ImplicitDepsInferringDescription
TargetNodeImpl<T>	withSelectedVersions(Optional<? extends com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions)
TargetNodeImpl<T>	withTargetGraphOnlyDeps(com.google.common.collect.ImmutableSortedSet<BuildTarget> targetGraphOnlyDeps)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.core.model.targetgraph.TargetNode

cast, copyWithFlavors, getElement

Constructor Detail

TargetNodeImpl

public TargetNodeImpl()

Method Detail

check

@Value.Check
protected void check()

getBuildTarget

public abstract BuildTarget getBuildTarget()

Specified by:

getBuildTarget in interface HasBuildTarget

Specified by:

getBuildTarget in interface TargetNode<T extends ConstructorArg>

Specified by:

getBuildTarget in interface ObeysVisibility

getNodeCopier

public abstract NodeCopier getNodeCopier()

Specified by:

getNodeCopier in interface TargetNode<T extends ConstructorArg>

getDescription

@Value.Auxiliary
public abstract BaseDescription<T> getDescription()

Specified by:

getDescription in interface TargetNode<T extends ConstructorArg>

getConstructorArg

public abstract T getConstructorArg()

Specified by:

getConstructorArg in interface TargetNode<T extends ConstructorArg>

getFilesystem

public abstract ProjectFilesystem getFilesystem()

Specified by:

getFilesystem in interface TargetNode<T extends ConstructorArg>

getInputs

public abstract com.google.common.collect.ImmutableSet<ForwardRelativePath> getInputs()

Description copied from interface: TargetNode

Cell root-relative paths.

Specified by:

getInputs in interface TargetNode<T extends ConstructorArg>

getDeclaredDeps

public abstract com.google.common.collect.ImmutableSet<BuildTarget> getDeclaredDeps()

Specified by:

getDeclaredDeps in interface TargetNode<T extends ConstructorArg>

getExtraDeps

public abstract com.google.common.collect.ImmutableSortedSet<BuildTarget> getExtraDeps()

Specified by:

getExtraDeps in interface TargetNode<T extends ConstructorArg>

getTargetGraphOnlyDeps

public abstract com.google.common.collect.ImmutableSortedSet<BuildTarget> getTargetGraphOnlyDeps()

BuildTargetPaths which, when changed, may change the BuildRules produced by this TargetNode, but whose steps don't need executing in order to build this TargetNode's BuildRules.

A TargetNode may require metadata from other targets in order to be constructed, but may not actually require those targets' build output. For example, some targets may execute queries against the TargetGraph (e.g. detecting the names of rules of a certain type) but don't use the output of those detected rules.

Specified by:

getTargetGraphOnlyDeps in interface TargetNode<T extends ConstructorArg>

getConfigurationDeps

public abstract com.google.common.collect.ImmutableSortedSet<BuildTarget> getConfigurationDeps()

Description copied from interface: TargetNode

Provides a set of configuration targets that were used during the construction of this node.

For example, this set would include configuration targets specified as keys in select statements.

Specified by:

getConfigurationDeps in interface TargetNode<T extends ConstructorArg>

getVisibilityPatterns

public abstract com.google.common.collect.ImmutableSet<VisibilityPattern> getVisibilityPatterns()

Specified by:

getVisibilityPatterns in interface TargetNode<T extends ConstructorArg>

getWithinViewPatterns

public abstract com.google.common.collect.ImmutableSet<VisibilityPattern> getWithinViewPatterns()

Specified by:

getWithinViewPatterns in interface TargetNode<T extends ConstructorArg>

getSelectedVersions

public abstract Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> getSelectedVersions()

Specified by:

getSelectedVersions in interface TargetNode<T extends ConstructorArg>

getVisibilityChecker

@Value.Lazy
public VisibilityChecker getVisibilityChecker()

Specified by:

getVisibilityChecker in interface ObeysVisibility

getBuildDeps

public Set<BuildTarget> getBuildDeps()

Specified by:

getBuildDeps in interface TargetNode<T extends ConstructorArg>

Returns:

all targets which must be built before this one can be.

getParseDeps

public Set<BuildTarget> getParseDeps()

Specified by:

getParseDeps in interface TargetNode<T extends ConstructorArg>

Returns:

all targets which must be present in the TargetGraph before this one can be transformed into a BuildRule.

getTotalDeps

public Set<BuildTarget> getTotalDeps()

Description copied from interface: TargetNode

Dependencies that include build targets as well as configuration targets that this node depends on.

Specified by:

getTotalDeps in interface TargetNode<T extends ConstructorArg>

isVisibleTo

public boolean isVisibleTo(TargetNode<?> viewer)

Specified by:

isVisibleTo in interface TargetNode<T extends ConstructorArg>

isVisibleToOrThrow

public void isVisibleToOrThrow(TargetNode<?> viewer)

Specified by:

isVisibleToOrThrow in interface TargetNode<T extends ConstructorArg>

getRuleType

public RuleType getRuleType()

Specified by:

getRuleType in interface TargetNode<T extends ConstructorArg>

compareTo

public int compareTo(TargetNode<?> o)

Specified by:

compareTo in interface Comparable<TargetNode<?>>

toString

public final String toString()

Overrides:

toString in class Object

copyWithFlavors

public TargetNode<T> copyWithFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors)

Description copied from interface: TargetNode

This method copies this target node with applying logic in ImplicitDepsInferringDescription that may give different results for deps based on flavors.

Note that this method strips away selected versions, and may be buggy because of it.

Specified by:

copyWithFlavors in interface TargetNode<T extends ConstructorArg>

withFlavors

public TargetNodeImpl<T> withFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors)

Description copied from interface: TargetNode

This method copies this target node without applying logic in ImplicitDepsInferringDescription

Specified by:

withFlavors in interface TargetNode<T extends ConstructorArg>

withBuildTarget

public TargetNodeImpl<T> withBuildTarget(BuildTarget buildTarget)

Specified by:

withBuildTarget in interface TargetNode<T extends ConstructorArg>

withConstructorArg

public TargetNodeImpl<T> withConstructorArg(T constructorArg)

Specified by:

withConstructorArg in interface TargetNode<T extends ConstructorArg>

withDeclaredDeps

public TargetNodeImpl<T> withDeclaredDeps(Iterable<? extends BuildTarget> declaredDeps)

Specified by:

withDeclaredDeps in interface TargetNode<T extends ConstructorArg>

withExtraDeps

public TargetNodeImpl<T> withExtraDeps(com.google.common.collect.ImmutableSortedSet<BuildTarget> extraDeps)

Specified by:

withExtraDeps in interface TargetNode<T extends ConstructorArg>

withTargetGraphOnlyDeps

public TargetNodeImpl<T> withTargetGraphOnlyDeps(com.google.common.collect.ImmutableSortedSet<BuildTarget> targetGraphOnlyDeps)

Specified by:

withTargetGraphOnlyDeps in interface TargetNode<T extends ConstructorArg>

withSelectedVersions

public TargetNodeImpl<T> withSelectedVersions(Optional<? extends com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions)

Specified by:

withSelectedVersions in interface TargetNode<T extends ConstructorArg>

of

public static <T extends ConstructorArg> TargetNodeImpl<T> of(BuildTarget buildTarget,
                                                              NodeCopier nodeCopier,
                                                              BaseDescription<T> description,
                                                              T constructorArg,
                                                              ProjectFilesystem filesystem,
                                                              com.google.common.collect.ImmutableSet<ForwardRelativePath> inputs,
                                                              com.google.common.collect.ImmutableSet<BuildTarget> declaredDeps,
                                                              com.google.common.collect.ImmutableSortedSet<BuildTarget> extraDeps,
                                                              com.google.common.collect.ImmutableSortedSet<BuildTarget> targetGraphOnlyDeps,
                                                              com.google.common.collect.ImmutableSortedSet<BuildTarget> configurationDeps,
                                                              com.google.common.collect.ImmutableSet<VisibilityPattern> visibilityPatterns,
                                                              com.google.common.collect.ImmutableSet<VisibilityPattern> withinViewPatterns,
                                                              Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions)