dagger.internal

Class Linker

java.lang.Object

dagger.internal.Linker

public final class Linker
extends Object

Links bindings to their dependencies.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Linker.ErrorHandler Handles linker errors appropriately.

Constructor Summary

Constructors

Constructor and Description
Linker(Linker base, Loader plugin, Linker.ErrorHandler errorHandler)

Method Summary

Modifier and Type	Method and Description
Map<String,Binding<?>>	fullyLinkedBindings() Returns the map of all bindings available to this Linker, if and only if linkAll() has successfully returned at least once, otherwise it returns null;
void	installBindings(BindingsGroup toInstall) Adds all bindings in toInstall.
Map<String,Binding<?>>	linkAll() Links all known bindings (whether requested or installed), plus all of their transitive dependencies.
void	linkRequested() Links all requested bindings plus their transitive dependencies.
Binding<?>	requestBinding(String key, Object requiredBy) Deprecated. Older, generated code still using this should be re-generated.
Binding<?>	requestBinding(String key, Object requiredBy, boolean mustHaveInjections, boolean library) Deprecated. Older, generated code still using this should be re-generated.
Binding<?>	requestBinding(String key, Object requiredBy, ClassLoader classLoader) Returns the binding if it exists immediately.
Binding<?>	requestBinding(String key, Object requiredBy, ClassLoader classLoader, boolean mustHaveInjections, boolean library) Returns the binding if it exists immediately.

Methods inherited from class java.lang.Object

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

Constructor Detail

Linker

public Linker(Linker base,
              Loader plugin,
              Linker.ErrorHandler errorHandler)

Method Detail

installBindings

public void installBindings(BindingsGroup toInstall)

Adds all bindings in toInstall. The caller must call either linkAll() or requestBinding(java.lang.String, java.lang.Object) and linkRequested() before the bindings can be used. This method may only be called before linkAll(). Subsequent calls to installBindings(BindingsGroup) will throw an IllegalStateException.

linkAll

public Map<String,Binding<?>> linkAll()

Links all known bindings (whether requested or installed), plus all of their transitive dependencies. This loads injectable types' bindings as necessary to fill in the gaps. If this method has returned successfully at least once, all further work is short-circuited.

Throws:

AssertionError - if this method is not called within a synchronized block which holds this Linker as the lock object.

fullyLinkedBindings

public Map<String,Binding<?>> fullyLinkedBindings()

Returns the map of all bindings available to this Linker, if and only if linkAll() has successfully returned at least once, otherwise it returns null;

linkRequested

public void linkRequested()

Links all requested bindings plus their transitive dependencies. This creates JIT bindings as necessary to fill in the gaps.

Throws:

AssertionError - if this method is not called within a synchronized block which holds this Linker as the lock object.

requestBinding

@Deprecated
public Binding<?> requestBinding(String key,
                                             Object requiredBy)

Deprecated. Older, generated code still using this should be re-generated.

requestBinding

public Binding<?> requestBinding(String key,
                                 Object requiredBy,
                                 ClassLoader classLoader)

Returns the binding if it exists immediately. Otherwise this returns null. If the returned binding didn't exist or was unlinked, it will be enqueued to be linked.

requestBinding

@Deprecated
public Binding<?> requestBinding(String key,
                                             Object requiredBy,
                                             boolean mustHaveInjections,
                                             boolean library)

Deprecated. Older, generated code still using this should be re-generated.

requestBinding

public Binding<?> requestBinding(String key,
                                 Object requiredBy,
                                 ClassLoader classLoader,
                                 boolean mustHaveInjections,
                                 boolean library)

Returns the binding if it exists immediately. Otherwise this returns null. If the returned binding didn't exist or was unlinked, it will be enqueued to be linked.

Parameters:

mustHaveInjections - true if the the referenced key requires either an @Inject annotation is produced by a @Provides method. This isn't necessary for Module.injects types because frameworks need to inject arbitrary classes like JUnit test cases and Android activities. It also isn't necessary for supertypes.