dagger.model

Class BindingGraph

java.lang.Object

dagger.model.BindingGraph

public final class BindingGraph
extends java.lang.Object

The immutable graph of bindings, dependency requests, and components for a valid root component.

Nodes

There is a binding node for each owned binding in the graph. If a binding is owned by more than one component, there is one binding node for that binding for every owning component.

There is a component node (without a binding) for each component in the graph.

Edges

There is a dependency edge for each dependency request in the graph. Its target node is the binding node for the binding that satisfies the request. For entry point dependency requests, the source node is the component node for the component for which it is an entry point. For other dependency requests, the source node is the binding node for the binding that contains the request.

There is a subcomponent edge for each parent-child component relationship in the graph. The target node is the component node for the child component. For subcomponents defined by a subcomponent builder binding (either a method on the component or a set of @Module.subcomponents annotation values), the source node is the binding node for the @Subcomponent.Builder type. For subcomponents defined by subcomponent factory methods, the source node is the component node for the parent.

Note that this API is experimental and will change.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BindingGraph.BindingNode A binding node in the binding graph.
static interface	BindingGraph.ChildFactoryMethodEdge An edge that represents a subcomponent factory method linking a parent component to a child subcomponent.
static interface	BindingGraph.ComponentNode A component node in the graph.
static interface	BindingGraph.DependencyEdge An edge that represents a dependency on a binding.
static interface	BindingGraph.Edge An edge in the binding graph.
static interface	BindingGraph.MaybeBindingNode A node in the binding graph that is either a BindingGraph.BindingNode or a BindingGraph.MissingBindingNode.
static class	BindingGraph.MissingBindingNode A node in the binding graph that represents a missing binding for a key in a component.
static interface	BindingGraph.Node A node in the binding graph.
static interface	BindingGraph.SubcomponentBuilderBindingEdge An edge that represents the link between a parent component and a child subcomponent implied by a subcomponent builder binding.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<BindingGraph.BindingNode>	bindingNodes() Returns the binding nodes.
com.google.common.collect.ImmutableSet<BindingGraph.BindingNode>	bindingNodes(Key key) Returns the binding nodes for a key.
java.util.Optional<BindingGraph.ComponentNode>	componentNode(ComponentPath component) Returns the component node for a component.
com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode>	componentNodes() Returns the component nodes.
com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode>	componentNodes(javax.lang.model.element.TypeElement component) Returns the component nodes for a component.
com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge>	dependencyEdges() Returns the dependency edges.
com.google.common.collect.ImmutableSetMultimap<DependencyRequest,BindingGraph.DependencyEdge>	dependencyEdges(BindingGraph.BindingNode bindingNode) Returns the dependency edges for the dependencies of a binding.
com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge>	dependencyEdges(DependencyRequest dependencyRequest) Returns the dependency edges for a dependency request.
com.google.common.collect.ImmutableSet<BindingGraph.MaybeBindingNode>	entryPointBindingNodes() Returns the binding nodes or missing binding nodes that directly satisfy entry points.
com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge>	entryPointEdges() Returns the dependency edges for all entry points for all components and subcomponents.
com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge>	entryPointEdges(ComponentPath component) Returns the dependency edges for the entry points of a given component.
com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge>	entryPointEdgesDependingOnBindingNode(BindingGraph.MaybeBindingNode bindingNode) Returns the edges for entry points that transitively depend on a binding or missing binding for a key.
boolean	equals(java.lang.Object other)
int	hashCode()
com.google.common.collect.ImmutableSet<BindingGraph.MissingBindingNode>	missingBindingNodes() Returns the nodes that represent missing bindings.
com.google.common.graph.ImmutableNetwork<BindingGraph.Node,BindingGraph.Edge>	network() Returns the graph in its Network representation.
BindingGraph.ComponentNode	rootComponentNode() Returns the component node for the root component.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

network

public com.google.common.graph.ImmutableNetwork<BindingGraph.Node,BindingGraph.Edge> network()

Returns the graph in its Network representation.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

bindingNodes

public com.google.common.collect.ImmutableSet<BindingGraph.BindingNode> bindingNodes()

Returns the binding nodes.

bindingNodes

public com.google.common.collect.ImmutableSet<BindingGraph.BindingNode> bindingNodes(Key key)

Returns the binding nodes for a key.

missingBindingNodes

public com.google.common.collect.ImmutableSet<BindingGraph.MissingBindingNode> missingBindingNodes()

Returns the nodes that represent missing bindings.

componentNodes

public com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode> componentNodes()

Returns the component nodes.

componentNode

public java.util.Optional<BindingGraph.ComponentNode> componentNode(ComponentPath component)

Returns the component node for a component.

componentNodes

public com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode> componentNodes(javax.lang.model.element.TypeElement component)

Returns the component nodes for a component.

rootComponentNode

public BindingGraph.ComponentNode rootComponentNode()

Returns the component node for the root component.

dependencyEdges

public com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> dependencyEdges()

Returns the dependency edges.

dependencyEdges

public com.google.common.collect.ImmutableSetMultimap<DependencyRequest,BindingGraph.DependencyEdge> dependencyEdges(BindingGraph.BindingNode bindingNode)

Returns the dependency edges for the dependencies of a binding. For valid graphs, each DependencyRequest will map to a single BindingGraph.DependencyEdge. When conflicting bindings exist for a key, the multimap will have several edges for that DependencyRequest. Graphs that have no binding for a key will have an edge whose target node is a BindingGraph.MissingBindingNode.

dependencyEdges

public com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> dependencyEdges(DependencyRequest dependencyRequest)

Returns the dependency edges for a dependency request.

entryPointEdges

public com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> entryPointEdges(ComponentPath component)

Returns the dependency edges for the entry points of a given component. Each edge's source node is that component's component node.

entryPointEdges

public com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> entryPointEdges()

Returns the dependency edges for all entry points for all components and subcomponents. Each edge's source node is a component node.

entryPointBindingNodes

public com.google.common.collect.ImmutableSet<BindingGraph.MaybeBindingNode> entryPointBindingNodes()

Returns the binding nodes or missing binding nodes that directly satisfy entry points.

entryPointEdgesDependingOnBindingNode

public com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> entryPointEdgesDependingOnBindingNode(BindingGraph.MaybeBindingNode bindingNode)

Returns the edges for entry points that transitively depend on a binding or missing binding for a key. Never returns an empty set.