com.facebook.buck.query

Class TargetVariablesQueryEnvironment<NODE_TYPE>

java.lang.Object

com.facebook.buck.query.TargetVariablesQueryEnvironment<NODE_TYPE>

All Implemented Interfaces:

QueryEnvironment<NODE_TYPE>

public class TargetVariablesQueryEnvironment<NODE_TYPE>
extends Object
implements QueryEnvironment<NODE_TYPE>

Provides a view of an existing QueryEnvironment augmented with additional target variables.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.query.QueryEnvironment

QueryEnvironment.Argument<ENV_NODE_TYPE>, QueryEnvironment.ArgumentType, QueryEnvironment.QueryFunction<OUTPUT_TYPE extends QueryTarget,ENV_NODE_TYPE>, QueryEnvironment.TargetEvaluator

Constructor Summary

Constructors

Constructor and Description
TargetVariablesQueryEnvironment(com.google.common.collect.ImmutableMap<String,Set<NODE_TYPE>> targetVariables, QueryEnvironment<NODE_TYPE> delegate)

Method Summary

Modifier and Type	Method and Description
void	buildTransitiveClosure(Set<? extends QueryTarget> targetNodes, int maxDepth) Construct the dependency graph for a depth-bounded forward transitive closure of all nodes in "targetNodes".
Set<Object>	filterAttributeContents(NODE_TYPE target, String attribute, java.util.function.Predicate<Object> predicate) Returns the objects in the `attribute` of the given `target` that satisfy `predicate`
Set<QueryFileTarget>	getBuildFiles(Set<NODE_TYPE> targets) Returns the build files that define the given targets.
Set<NODE_TYPE>	getFileOwners(com.google.common.collect.ImmutableList<String> files) Returns the targets that own one or more of the given files.
Iterable<QueryEnvironment.QueryFunction<?,NODE_TYPE>>	getFunctions() Returns the set of query functions implemented by this query environment.
Set<NODE_TYPE>	getFwdDeps(Iterable<NODE_TYPE> targets) Returns the direct forward dependencies of the specified targets.
Set<QueryFileTarget>	getInputs(NODE_TYPE target)
Set<NODE_TYPE>	getReverseDeps(Iterable<NODE_TYPE> targets) Returns the direct reverse dependencies of the specified targets.
QueryEnvironment.TargetEvaluator	getTargetEvaluator() Returns an evaluator for target patterns.
String	getTargetKind(NODE_TYPE target)
Set<? extends QueryTarget>	getTargetsInAttribute(NODE_TYPE target, String attribute) Returns the existing targets in the value of `attribute` of the given `target`.
Set<NODE_TYPE>	getTestsForTarget(NODE_TYPE target) Returns the tests associated with the given target.
Set<NODE_TYPE>	getTransitiveClosure(Set<NODE_TYPE> targets) Returns the forward transitive closure of all of the targets in "targets".
Set<NODE_TYPE>	resolveTargetVariable(String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.query.QueryEnvironment

forEachFwdDep, getTargetsMatchingPattern

Constructor Detail

TargetVariablesQueryEnvironment

public TargetVariablesQueryEnvironment(com.google.common.collect.ImmutableMap<String,Set<NODE_TYPE>> targetVariables,
                                       QueryEnvironment<NODE_TYPE> delegate)

Method Detail

getTargetEvaluator

public QueryEnvironment.TargetEvaluator getTargetEvaluator()

Description copied from interface: QueryEnvironment

Returns an evaluator for target patterns.

Specified by:

getTargetEvaluator in interface QueryEnvironment<NODE_TYPE>

getFwdDeps

public Set<NODE_TYPE> getFwdDeps(Iterable<NODE_TYPE> targets)
                          throws QueryException

Description copied from interface: QueryEnvironment

Returns the direct forward dependencies of the specified targets.

Specified by:

getFwdDeps in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getReverseDeps

public Set<NODE_TYPE> getReverseDeps(Iterable<NODE_TYPE> targets)
                              throws QueryException

Description copied from interface: QueryEnvironment

Returns the direct reverse dependencies of the specified targets.

Specified by:

getReverseDeps in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getInputs

public Set<QueryFileTarget> getInputs(NODE_TYPE target)
                               throws QueryException

Specified by:

getInputs in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getTransitiveClosure

public Set<NODE_TYPE> getTransitiveClosure(Set<NODE_TYPE> targets)
                                    throws QueryException

Description copied from interface: QueryEnvironment

Returns the forward transitive closure of all of the targets in "targets". Callers must ensure that QueryEnvironment.buildTransitiveClosure(java.util.Set<? extends com.facebook.buck.core.model.QueryTarget>, int) has been called for the relevant subgraph.

Specified by:

getTransitiveClosure in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

buildTransitiveClosure

public void buildTransitiveClosure(Set<? extends QueryTarget> targetNodes,
                                   int maxDepth)
                            throws QueryException

Description copied from interface: QueryEnvironment

Construct the dependency graph for a depth-bounded forward transitive closure of all nodes in "targetNodes". The identity of the calling expression is required to produce error messages.

If a larger transitive closure was already built, returns it to improve incrementality, since all depth-constrained methods filter it after it is built anyway.

Specified by:

buildTransitiveClosure in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getTargetKind

public String getTargetKind(NODE_TYPE target)
                     throws QueryException

Specified by:

getTargetKind in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getTestsForTarget

public Set<NODE_TYPE> getTestsForTarget(NODE_TYPE target)
                                 throws QueryException

Description copied from interface: QueryEnvironment

Returns the tests associated with the given target.

Specified by:

getTestsForTarget in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getBuildFiles

public Set<QueryFileTarget> getBuildFiles(Set<NODE_TYPE> targets)
                                   throws QueryException

Description copied from interface: QueryEnvironment

Returns the build files that define the given targets.

Specified by:

getBuildFiles in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getFileOwners

public Set<NODE_TYPE> getFileOwners(com.google.common.collect.ImmutableList<String> files)
                             throws QueryException

Description copied from interface: QueryEnvironment

Returns the targets that own one or more of the given files.

Specified by:

getFileOwners in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getTargetsInAttribute

public Set<? extends QueryTarget> getTargetsInAttribute(NODE_TYPE target,
                                                        String attribute)
                                                 throws QueryException

Description copied from interface: QueryEnvironment

Returns the existing targets in the value of `attribute` of the given `target`.

Note that unlike most methods in this interface, this method can return a heterogeneous collection of objects that implement QueryTarget.

Specified by:

getTargetsInAttribute in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

filterAttributeContents

public Set<Object> filterAttributeContents(NODE_TYPE target,
                                           String attribute,
                                           java.util.function.Predicate<Object> predicate)
                                    throws QueryException

Description copied from interface: QueryEnvironment

Returns the objects in the `attribute` of the given `target` that satisfy `predicate`

Specified by:

filterAttributeContents in interface QueryEnvironment<NODE_TYPE>

Throws:

QueryException

getFunctions

public Iterable<QueryEnvironment.QueryFunction<?,NODE_TYPE>> getFunctions()

Description copied from interface: QueryEnvironment

Returns the set of query functions implemented by this query environment.

Specified by:

getFunctions in interface QueryEnvironment<NODE_TYPE>

resolveTargetVariable

public Set<NODE_TYPE> resolveTargetVariable(String name)

Specified by:

resolveTargetVariable in interface QueryEnvironment<NODE_TYPE>

Returns:

the QueryTargets expanded from the given variable name.