com.facebook.buck.core.util.graph

Class AbstractBreadthFirstThrowingTraversal<Node,E extends Throwable>

java.lang.Object

com.facebook.buck.core.util.graph.AbstractBreadthFirstThrowingTraversal<Node,E>

Direct Known Subclasses:

AbstractBreadthFirstThrowingTraversal.StaticBreadthFirstTraversal, AbstractBreadthFirstTraversal

public abstract class AbstractBreadthFirstThrowingTraversal<Node,E extends Throwable>
extends Object

Performs a breadth-first traversal of dependencies of a graph node.

In cases where the cost of allocating Iterables for node dependencies is expensive/costly, ConsumingTraverser.breadthFirst(Iterable, ForEachSuccessorFunction) provides a lighter-weight option.

TODO: Implement via ConsumingTraverser.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractBreadthFirstThrowingTraversal.StaticBreadthFirstTraversal<Node>
static interface	AbstractBreadthFirstThrowingTraversal.Visitor<Node,E extends Throwable> This will typically be implemented as a lambda passed to traverse(Object, Visitor) or traverse(Iterable, Visitor)

Constructor Summary

Constructors

Constructor and Description
AbstractBreadthFirstThrowingTraversal(Iterable<? extends Node> initialNodes)
AbstractBreadthFirstThrowingTraversal(Node initialNode)

Method Summary

Modifier and Type	Method and Description
protected void	onComplete() Override this method with any logic that should be run when start() completes.
void	start()
static <Node> void	traverse(Iterable<? extends Node> initialNodes, AbstractBreadthFirstThrowingTraversal.Visitor<Node,RuntimeException> visitor) Traverse a graph without explicitly creating a new AbstractBreadthFirstThrowingTraversal and overriding visit(Object)
static <Node> void	traverse(Node initialNode, AbstractBreadthFirstThrowingTraversal.Visitor<Node,RuntimeException> visitor) Traverse a graph without explicitly creating a new AbstractBreadthFirstThrowingTraversal and overriding visit(Object)
abstract Iterable<? extends Node>	visit(Node node) To perform a full traversal of the the initialNode's transitive dependencies, this function should return all of node's direct dependencies.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBreadthFirstThrowingTraversal

public AbstractBreadthFirstThrowingTraversal(Node initialNode)

AbstractBreadthFirstThrowingTraversal

public AbstractBreadthFirstThrowingTraversal(Iterable<? extends Node> initialNodes)

Method Detail

start

public final void start()
                 throws E extends Throwable

Throws:

E extends Throwable

onComplete

protected void onComplete()
                   throws E extends Throwable

Override this method with any logic that should be run when start() completes.

Throws:

E extends Throwable

visit

public abstract Iterable<? extends Node> visit(Node node)
                                        throws E extends Throwable

To perform a full traversal of the the initialNode's transitive dependencies, this function should return all of node's direct dependencies.

Parameters:

node - Visited graph node

Returns:

The set of direct dependencies to visit after visiting this node.

Throws:

E extends Throwable

traverse

public static <Node> void traverse(Node initialNode,
                                   AbstractBreadthFirstThrowingTraversal.Visitor<Node,RuntimeException> visitor)

Traverse a graph without explicitly creating a new AbstractBreadthFirstThrowingTraversal and overriding visit(Object)

Parameters:

visitor - Typically a lambda expression

traverse

public static <Node> void traverse(Iterable<? extends Node> initialNodes,
                                   AbstractBreadthFirstThrowingTraversal.Visitor<Node,RuntimeException> visitor)

Traverse a graph without explicitly creating a new AbstractBreadthFirstThrowingTraversal and overriding visit(Object)

Parameters:

visitor - Typically a lambda expression