dagger.releasablereferences

Interface ReleasableReferenceManager

All Known Subinterfaces:

TypedReleasableReferenceManager<M>

@Beta
public interface ReleasableReferenceManager

An object that can release or restore strong references held in a @CanReleaseReferences scope.

Your top-level component can provide a @ForReleasableReferences(Foo.class) ReleasableReferenceManager object for any @CanReleaseReferences-annotated scope Foo anywhere in your component hierarchy.

It can also provide a Set<ReleasableReferenceManager> that contains all such objects.

Each provider in the @CanReleaseReferences scope() can be in any one of four states at a time:

• In uninitialized state, the provider's strong reference and its WeakReference are both null.
• In cleared state, the provider's strong reference is null, and its WeakReference's value is null.
• In strong-reference state, the provider's strong reference refers to the cached value, and its WeakReference is null.
• In weak-reference state, the provider's strong reference is null, and its WeakReference's value is not null.

All providers within scope() start in uninitialized state.

Calling Provider.get() on a provider within scope() transitions it to strong-reference state if it was in uninitialized or empty state.

releaseStrongReferences() transitions all providers within scope() that are in strong-reference state to weak-reference state.

restoreStrongReferences() transitions all providers within scope() that are in weak-reference state to strong-reference state.

If garbage collection clears the WeakReference for any provider within scope() that is in weak-reference state, that provider transitions to cleared state.

This interface is implemented by Dagger.

Since:

2.8

Method Summary

Modifier and Type	Method and Description
void	releaseStrongReferences() Releases the strong references held by all providers in this scope to the objects previously returned by Provider.get(), leaving only WeakReferences.
void	restoreStrongReferences() Restores strong references for all providers in this scope that were previously released but whose WeakReference has not yet been cleared during garbage collection.
Class<? extends Annotation>	scope() The scope whose references are managed by this object.

Method Detail

scope

Class<? extends Annotation> scope()

The scope whose references are managed by this object.

releaseStrongReferences

void releaseStrongReferences()

Releases the strong references held by all providers in this scope to the objects previously returned by Provider.get(), leaving only WeakReferences.

If any such WeakReference is cleared during garbage collection, the next call to that Provider.get() will execute the underlying binding again, and the provider will hold a strong reference to the new returned value.

Calls to Provider.get() on any such provider return the weakly-referenced object until the WeakReference is cleared or restoreStrongReferences() is called.

restoreStrongReferences

void restoreStrongReferences()

Restores strong references for all providers in this scope that were previously released but whose WeakReference has not yet been cleared during garbage collection.