Package dagger.spi.model

Class BindingGraph

java.lang.Object

dagger.spi.model.BindingGraph

public abstract class BindingGraph
extends Object

A graph of bindings, dependency requests, and components.

A BindingGraph represents one of the following:

• an entire component hierarchy rooted at a Component or ProductionComponent
• a partial component hierarchy rooted at a Subcomponent or ProductionSubcomponent (only when the value of -Adagger.fullBindingGraphValidation is not NONE)
• the bindings installed by a Module or ProducerModule, including all subcomponents generated by Module.subcomponents() ()} and ProducerModule#subcomponents() ()}

In the case of a BindingGraph representing a module, the root BindingGraph.ComponentNode will actually represent the module type. The graph will also be a full binding graph, which means it will contain all bindings in all modules, as well as nodes for their dependencies. Otherwise it will contain only bindings that are reachable from at least one entry point.

Nodes

There is a Binding for each owned binding in the graph. If a binding is owned by more than one component, there is one binding object 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 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 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 creator binding (either a method on the component or a set of @Module.subcomponents annotation values), the source node is the binding 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	Description
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.MaybeBinding	A node in the binding graph that is either a Binding or a BindingGraph.MissingBinding.
static class	BindingGraph.MissingBinding	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.SubcomponentCreatorBindingEdge	An edge that represents the link between a parent component and a child subcomponent implied by a subcomponent creator (builder or factory) binding.

Constructor Summary

Constructors

Constructor	Description
BindingGraph()

Method Summary

Modifier and Type	Method	Description
abstract DaggerProcessingEnv.Backend	backend()
com.google.common.collect.ImmutableSet<Binding>	bindings()	Returns the bindings.
com.google.common.collect.ImmutableSet<Binding>	bindings(Key key)	Returns the bindings for a key.
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(DaggerTypeElement 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(Binding binding)	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.
protected com.google.common.graph.ImmutableNetwork<BindingGraph.Node,BindingGraph.DependencyEdge>	dependencyGraph()	Returns a subnetwork that contains all nodes but only BindingGraph.DependencyEdges.
com.google.common.collect.ImmutableSet<BindingGraph.MaybeBinding>	entryPointBindings()	Returns the binding 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>	entryPointEdgesDependingOnBinding(BindingGraph.MaybeBinding binding)	Returns the edges for entry points that transitively depend on a binding or missing binding for a key.
abstract boolean	isFullBindingGraph()	Returns true if this is a full binding graph, which contains all bindings installed in the component, or false if it is a reachable binding graph, which contains only bindings that are reachable from at least one entry point.
boolean	isModuleBindingGraph()	Deprecated. use isFullBindingGraph() to tell if this is a full binding graph, or rootComponentNode().isRealComponent() to tell if the root component node is really a component or derived from a module.
boolean	isPartialBindingGraph()	Deprecated. use rootComponentNode().isSubcomponent() instead
com.google.common.collect.ImmutableSet<BindingGraph.MissingBinding>	missingBindings()	Returns the nodes that represent missing bindings.
abstract com.google.common.graph.ImmutableNetwork<BindingGraph.Node,BindingGraph.Edge>	network()	Returns the graph in its Network representation.
protected com.google.common.collect.ImmutableSetMultimap<Class<? extends BindingGraph.Node>,? extends BindingGraph.Node>	nodesByClass()
com.google.common.collect.ImmutableSet<Binding>	requestedBindings(Binding binding)	Returns the bindings that a given binding directly requests as a dependency.
com.google.common.collect.ImmutableSet<BindingGraph.MaybeBinding>	requestedMaybeMissingBindings(Binding binding)	Returns the bindings or missing bindings that a given binding directly requests as a dependency.
com.google.common.collect.ImmutableSet<Binding>	requestingBindings(BindingGraph.MaybeBinding binding)	Returns the bindings that directly request a given binding as a dependency.
BindingGraph.ComponentNode	rootComponentNode()	Returns the component node for the root component.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BindingGraph

public BindingGraph()

Method Details

network

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

Returns the graph in its Network representation.

toString

public String toString()

Overrides:

toString in class Object

isModuleBindingGraph

@Deprecated
public boolean isModuleBindingGraph()

Deprecated.

use isFullBindingGraph() to tell if this is a full binding graph, or rootComponentNode().isRealComponent() to tell if the root component node is really a component or derived from a module. Dagger can generate full binding graphs for components and subcomponents as well as modules.

Returns true if this graph was constructed from a module for full binding graph validation.

isFullBindingGraph

public abstract boolean isFullBindingGraph()

Returns true if this is a full binding graph, which contains all bindings installed in the component, or false if it is a reachable binding graph, which contains only bindings that are reachable from at least one entry point.

See Also:

• Full binding graph validation

backend

public abstract DaggerProcessingEnv.Backend backend()

isPartialBindingGraph

@Deprecated
public boolean isPartialBindingGraph()

Deprecated.

use rootComponentNode().isSubcomponent() instead

Returns true if the rootComponentNode() is a subcomponent. This occurs in when -Adagger.fullBindingGraphValidation is used in a compilation with a subcomponent.

bindings

public com.google.common.collect.ImmutableSet<Binding> bindings()

Returns the bindings.

bindings

public com.google.common.collect.ImmutableSet<Binding> bindings(Key key)

Returns the bindings for a key.

missingBindings

public com.google.common.collect.ImmutableSet<BindingGraph.MissingBinding> missingBindings()

Returns the nodes that represent missing bindings.

componentNodes

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

Returns the component nodes.

componentNode

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

Returns the component node for a component.

componentNodes

public com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode> componentNodes(DaggerTypeElement 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(Binding binding)

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.MissingBinding.

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.

entryPointBindings

public com.google.common.collect.ImmutableSet<BindingGraph.MaybeBinding> entryPointBindings()

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

entryPointEdgesDependingOnBinding

public com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> entryPointEdgesDependingOnBinding(BindingGraph.MaybeBinding binding)

Returns the edges for entry points that transitively depend on a binding or missing binding for a key.

requestingBindings

public com.google.common.collect.ImmutableSet<Binding> requestingBindings(BindingGraph.MaybeBinding binding)

Returns the bindings that directly request a given binding as a dependency.

requestedBindings

public com.google.common.collect.ImmutableSet<Binding> requestedBindings(Binding binding)

Returns the bindings that a given binding directly requests as a dependency. Does not include any BindingGraph.MissingBindings.

See Also:

• requestedMaybeMissingBindings(Binding)

requestedMaybeMissingBindings

public com.google.common.collect.ImmutableSet<BindingGraph.MaybeBinding> requestedMaybeMissingBindings(Binding binding)

Returns the bindings or missing bindings that a given binding directly requests as a dependency.

See Also:

• requestedBindings(Binding)

dependencyGraph

protected com.google.common.graph.ImmutableNetwork<BindingGraph.Node,BindingGraph.DependencyEdge> dependencyGraph()

Returns a subnetwork that contains all nodes but only BindingGraph.DependencyEdges.

nodesByClass

protected com.google.common.collect.ImmutableSetMultimap<Class<? extends BindingGraph.Node>,? extends BindingGraph.Node> nodesByClass()