dagger.internal.codegen

Class ComponentTreeTraverser.BindingGraphTraverser

java.lang.Object

dagger.internal.codegen.ComponentTreeTraverser.BindingGraphTraverser

Enclosing class:

ComponentTreeTraverser

public static class ComponentTreeTraverser.BindingGraphTraverser
extends Object

An object that traverses the binding graph starting from an entry point.

Constructor Summary

Constructors

Constructor and Description
BindingGraphTraverser(ComponentTreeTraverser.ComponentTreePath componentPath, dagger.internal.codegen.DependencyRequest entryPoint) Constructs a traverser for an entry point.

Method Summary

Modifier and Type	Method and Description
protected boolean	atDependencyCycle() Returns true if the current dependency request is also higher in the dependency path.
protected boolean	atEntryPoint() Returns true if the current dependency request is an entry point.
protected ComponentTreeTraverser.ComponentTreePath	componentTreePath() Returns the path from the root component to the component that includes the entryPointElement() entry point.
protected dagger.internal.codegen.BindingGraph	currentGraph() Returns the binding graph for the component that is currently being visited.
protected ComponentTreeTraverser.DependencyTrace	cycleDependencyTrace() Returns the dependency requests and resolved bindings in the dependency cycle, starting with the request closest to the entry point and ending with the current dependency request.
protected dagger.internal.codegen.DependencyRequest	dependencyRequest() Returns the dependency request currently being visited.
protected ComponentTreeTraverser.DependencyTrace	dependencyTrace() Returns the dependency requests and resolved bindings starting with the entry point and ending with the current dependency request.
protected ImmutableSet<? extends dagger.internal.codegen.Binding>	dependentBindings() Returns the bindings that depend directly on the current dependency request.
protected Element	entryPointElement() Returns the entry point whose dependencies are currently being traversed.
dagger.internal.codegen.BindingGraph	owningGraph(Iterable<dagger.internal.codegen.ContributionBinding> bindings) Returns the rootmost of the binding graphs in the component path that own each binding.
protected dagger.internal.codegen.ResolvedBindings	resolvedBindings() Returns the resolved bindings for the current dependency request.
void	traverseDependencies() Calls visitDependencyRequest(DependencyRequest) for the entry point.
protected void	visitBinding(dagger.internal.codegen.Binding binding, dagger.internal.codegen.ComponentDescriptor owningComponent) Called once for each binding that is reachable from an entry point.
protected void	visitContributionBinding(dagger.internal.codegen.ContributionBinding binding, dagger.internal.codegen.ComponentDescriptor owningComponent) Called once for each contribution binding that is reachable from an entry point.
protected void	visitContributionBindings(dagger.internal.codegen.ResolvedBindings resolvedBindings) Called once for each dependency request for a contribution that is reachable from an entry point.
protected void	visitDependencyRequest(dagger.internal.codegen.DependencyRequest dependencyRequest) Called once for each dependency request that is reachable from an entry point.
protected void	visitMembersInjectionBinding(dagger.internal.codegen.MembersInjectionBinding binding, dagger.internal.codegen.ComponentDescriptor owningComponent) Called once for each members injection binding that is reachable from an entry point.
protected void	visitMembersInjectionBindings(dagger.internal.codegen.ResolvedBindings resolvedBindings) Called once for each dependency request for a members injector that is reachable from an entry point.
protected void	visitResolvedBindings(dagger.internal.codegen.ResolvedBindings resolvedBindings) Called once for each dependency request that is reachable from an entry point.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingGraphTraverser

public BindingGraphTraverser(ComponentTreeTraverser.ComponentTreePath componentPath,
                             dagger.internal.codegen.DependencyRequest entryPoint)

Constructs a traverser for an entry point.

Parameters:

componentPath - the path from the root component to the component that includes the entry point to be traversed

entryPoint - the entry point to be traversed

Method Detail

traverseDependencies

public void traverseDependencies()

Calls visitDependencyRequest(DependencyRequest) for the entry point.

Throws:

IllegalStateException - if a traversal is in progress

visitDependencyRequest

protected void visitDependencyRequest(dagger.internal.codegen.DependencyRequest dependencyRequest)

Called once for each dependency request that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per dependency request. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls visitResolvedBindings(ResolvedBindings) unless the dependency request introduces a cycle.

Parameters:

dependencyRequest - the object returned by dependencyRequest()

visitResolvedBindings

protected void visitResolvedBindings(dagger.internal.codegen.ResolvedBindings resolvedBindings)

Called once for each dependency request that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per resolved bindings. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls either visitMembersInjectionBindings(ResolvedBindings) or visitContributionBindings(ResolvedBindings), depending on the binding key kind.

Parameters:

resolvedBindings - the object returned by resolvedBindings()

visitMembersInjectionBindings

protected void visitMembersInjectionBindings(dagger.internal.codegen.ResolvedBindings resolvedBindings)

Called once for each dependency request for a members injector that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per resolved members injection bindings. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls visitMembersInjectionBinding(MembersInjectionBinding, ComponentDescriptor).

Parameters:

resolvedBindings - the object returned by resolvedBindings()

visitMembersInjectionBinding

protected void visitMembersInjectionBinding(dagger.internal.codegen.MembersInjectionBinding binding,
                                            dagger.internal.codegen.ComponentDescriptor owningComponent)

Called once for each members injection binding that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per members injection binding. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls visitBinding(Binding, ComponentDescriptor).

Parameters:

binding - the only value of resolvedBindings().allMembersInjectionBindings()

owningComponent - the only key of resolvedBindings().allMembersInjectionBindings(). The binding's dependencies should be resolved within this component.

visitContributionBindings

protected void visitContributionBindings(dagger.internal.codegen.ResolvedBindings resolvedBindings)

Called once for each dependency request for a contribution that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per resolved contribution bindings. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls visitContributionBinding(ContributionBinding, ComponentDescriptor) for each contribution binding.

Parameters:

resolvedBindings - the object returned by resolvedBindings()

visitContributionBinding

protected void visitContributionBinding(dagger.internal.codegen.ContributionBinding binding,
                                        dagger.internal.codegen.ComponentDescriptor owningComponent)

Called once for each contribution binding that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per contribution binding. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls visitBinding(Binding, ComponentDescriptor).

Parameters:

binding - a value of resolvedBindings().allContributionBindings()

owningComponent - the key of resolvedBindings().allContributionBindings() for binding. The binding's dependencies should be resolved within this component.

visitBinding

protected void visitBinding(dagger.internal.codegen.Binding binding,
                            dagger.internal.codegen.ComponentDescriptor owningComponent)

Called once for each binding that is reachable from an entry point.

Subclasses can override this method to perform whatever logic is required per binding. They should call the super implementation if they want to continue the traversal in the standard order.

This implementation calls visitDependencyRequest(DependencyRequest) for each dependency of the binding, resolved within owningComponent, that has not already been visited while traversing the current entry point.

Parameters:

binding - a value of resolvedBindings().allBindings()

owningComponent - the key of resolvedBindings().allBindings() for binding. The binding's dependencies should be resolved within this component.

componentTreePath

protected final ComponentTreeTraverser.ComponentTreePath componentTreePath()

Returns the path from the root component to the component that includes the entryPointElement() entry point.

owningGraph

public dagger.internal.codegen.BindingGraph owningGraph(Iterable<dagger.internal.codegen.ContributionBinding> bindings)

Returns the rootmost of the binding graphs in the component path that own each binding.

For arguments [x, y], if binding x is owned by component A and binding y is owned by component B, and A is an ancestor of B, then this method returns the binding graph for A.

atDependencyCycle

protected final boolean atDependencyCycle()

Returns true if the current dependency request is also higher in the dependency path.

Throws:

IllegalStateException - if this object is not currently traversing dependencies

dependencyRequest

protected final dagger.internal.codegen.DependencyRequest dependencyRequest()

Returns the dependency request currently being visited.

Throws:

IllegalStateException - if this object is not currently traversing dependencies

resolvedBindings

protected final dagger.internal.codegen.ResolvedBindings resolvedBindings()

Returns the resolved bindings for the current dependency request.

Throws:

IllegalStateException - if this object is not currently traversing dependencies

dependentBindings

protected final ImmutableSet<? extends dagger.internal.codegen.Binding> dependentBindings()

Returns the bindings that depend directly on the current dependency request.

entryPointElement

protected final Element entryPointElement()

Returns the entry point whose dependencies are currently being traversed.

Throws:

IllegalStateException - if this object is not currently traversing dependencies

atEntryPoint

protected final boolean atEntryPoint()

Returns true if the current dependency request is an entry point.

currentGraph

protected final dagger.internal.codegen.BindingGraph currentGraph()

Returns the binding graph for the component that is currently being visited.

dependencyTrace

protected final ComponentTreeTraverser.DependencyTrace dependencyTrace()

Returns the dependency requests and resolved bindings starting with the entry point and ending with the current dependency request.

cycleDependencyTrace

protected final ComponentTreeTraverser.DependencyTrace cycleDependencyTrace()

Returns the dependency requests and resolved bindings in the dependency cycle, starting with the request closest to the entry point and ending with the current dependency request.

The first request and the last request in the trace will have the same binding key.