BindingGraph

java.lang.Object
- dagger.model.BindingGraph

```
public abstract class BindingGraph
extends java.lang.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 -Adagger.experimentalAheadOfTimeSubcomponents=enabled is passed to the compiler)
- 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 and 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.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`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(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.
`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. Dagger will soon generate full binding graphs for components and subcomponents as well as modules.
`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.
`com.google.common.collect.ImmutableSet<Binding>`	`requestedBindings(Binding binding)` Returns the bindings that a given binding directly request 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.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - network
```
public abstract com.google.common.graph.ImmutableNetwork<BindingGraph.Node,BindingGraph.Edge> network()
```
    Returns the graph in its Network representation.
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isModuleBindingGraph
```
@Deprecated
public final 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 will soon generate full binding graphs for components and subcomponents as well as modules.
    
    Returns true if this graph was constructed from a module for module binding validation.
    
    See Also:
    
    Module binding 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.
  - isPartialBindingGraph
```
@Deprecated
public final boolean isPartialBindingGraph()
```
    Deprecated. use rootComponentNode().isSubcomponent() instead
    
    Returns true if the rootComponentNode() is a subcomponent. This occurs in ahead-of-time-subcomponents mode.
  - bindings
```
public final com.google.common.collect.ImmutableSet<Binding> bindings()
```
    Returns the bindings.
  - bindings
```
public final com.google.common.collect.ImmutableSet<Binding> bindings(Key key)
```
    Returns the bindings for a key.
  - missingBindings
```
public final com.google.common.collect.ImmutableSet<BindingGraph.MissingBinding> missingBindings()
```
    Returns the nodes that represent missing bindings.
  - componentNodes
```
public final com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode> componentNodes()
```
    Returns the component nodes.
  - componentNode
```
public final java.util.Optional<BindingGraph.ComponentNode> componentNode(ComponentPath component)
```
    Returns the component node for a component.
  - componentNodes
```
public final com.google.common.collect.ImmutableSet<BindingGraph.ComponentNode> componentNodes(javax.lang.model.element.TypeElement component)
```
    Returns the component nodes for a component.
  - rootComponentNode
```
public final BindingGraph.ComponentNode rootComponentNode()
```
    Returns the component node for the root component.
  - dependencyEdges
```
public final com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> dependencyEdges()
```
    Returns the dependency edges.
  - dependencyEdges
```
public final 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 final com.google.common.collect.ImmutableSet<BindingGraph.DependencyEdge> dependencyEdges(DependencyRequest dependencyRequest)
```
    Returns the dependency edges for a dependency request.
  - entryPointEdges
```
public final 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 final 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 final com.google.common.collect.ImmutableSet<BindingGraph.MaybeBinding> entryPointBindings()
```
    Returns the binding or missing binding nodes that directly satisfy entry points.
  - entryPointEdgesDependingOnBinding
```
public final 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 final com.google.common.collect.ImmutableSet<Binding> requestingBindings(BindingGraph.MaybeBinding binding)
```
    Returns the bindings that directly request a given binding as a dependency.
  - requestedBindings
```
public final com.google.common.collect.ImmutableSet<Binding> requestedBindings(Binding binding)
```
    Returns the bindings that a given binding directly request as a dependency. Does not include any BindingGraph.MissingBindings.
    
    See Also:
    
    requestedMaybeMissingBindings(Binding)
  - requestedMaybeMissingBindings
```
public final 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)

Class BindingGraph

Nodes

Edges

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

network

toString

isModuleBindingGraph

isFullBindingGraph

isPartialBindingGraph

bindings

bindings

missingBindings

componentNodes

componentNode

componentNodes

rootComponentNode

dependencyEdges

dependencyEdges

dependencyEdges

entryPointEdges

entryPointEdges

entryPointBindings

entryPointEdgesDependingOnBinding

requestingBindings

requestedBindings

requestedMaybeMissingBindings