Skip to content

Commit 98fd6a1

Browse files
author
Dagger Team
committed
2.59.1 docs
1 parent 021ed88 commit 98fd6a1

627 files changed

Lines changed: 79117 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api/2.59.1/allclasses-index.html‎

Lines changed: 1107 additions & 0 deletions
Large diffs are not rendered by default.

‎api/2.59.1/allpackages-index.html‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) -->
5+
<title>All Packages</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF8">
8+
<meta name="description" content="package index">
9+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
10+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-packages-index-page">
18+
<script type="text/javascript">var pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top">
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="index.html">Overview</a></li>
31+
<li>Package</li>
32+
<li>Class</li>
33+
<li>Use</li>
34+
<li><a href="overview-tree.html">Tree</a></li>
35+
<li><a href="deprecated-list.html">Deprecated</a></li>
36+
<li><a href="index-all.html">Index</a></li>
37+
<li><a href="help-doc.html#all-packages">Help</a></li>
38+
</ul>
39+
</div>
40+
<div class="sub-nav">
41+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
42+
<input type="text" id="search-input" value="search" disabled="disabled">
43+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
44+
</div>
45+
</div>
46+
<!-- ========= END OF TOP NAVBAR ========= -->
47+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
48+
</header>
49+
<div class="flex-content">
50+
<main role="main">
51+
<div class="header">
52+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
53+
</div>
54+
<div class="caption"><span>Package Summary</span></div>
55+
<div class="summary-table two-column-summary">
56+
<div class="table-header col-first">Package</div>
57+
<div class="table-header col-last">Description</div>
58+
<div class="col-first even-row-color"><a href="dagger/package-summary.html">dagger</a></div>
59+
<div class="col-last even-row-color">
60+
<div class="block">This package contains the public API for the <a href="https://dagger.dev/">Dagger 2</a> dependency
61+
injection framework.</div>
62+
</div>
63+
<div class="col-first odd-row-color"><a href="dagger/android/package-summary.html">dagger.android</a></div>
64+
<div class="col-last odd-row-color">
65+
<div class="block">APIs to assist with performing injection on Android.</div>
66+
</div>
67+
<div class="col-first even-row-color"><a href="dagger/android/internal/package-summary.html">dagger.android.internal</a></div>
68+
<div class="col-last even-row-color">&nbsp;</div>
69+
<div class="col-first odd-row-color"><a href="dagger/android/support/package-summary.html">dagger.android.support</a></div>
70+
<div class="col-last odd-row-color">&nbsp;</div>
71+
<div class="col-first even-row-color"><a href="dagger/assisted/package-summary.html">dagger.assisted</a></div>
72+
<div class="col-last even-row-color">
73+
<div class="block">This package contains the API for Dagger's assisted injection.</div>
74+
</div>
75+
<div class="col-first odd-row-color"><a href="dagger/grpc/server/package-summary.html">dagger.grpc.server</a></div>
76+
<div class="col-last odd-row-color">&nbsp;</div>
77+
<div class="col-first even-row-color"><a href="dagger/hilt/package-summary.html">dagger.hilt</a></div>
78+
<div class="col-last even-row-color">
79+
<div class="block">This package contains the core APIs for Hilt.</div>
80+
</div>
81+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/package-summary.html">dagger.hilt.android</a></div>
82+
<div class="col-last odd-row-color">
83+
<div class="block">This package contains Hilt APIs for Android applications.</div>
84+
</div>
85+
<div class="col-first even-row-color"><a href="dagger/hilt/android/components/package-summary.html">dagger.hilt.android.components</a></div>
86+
<div class="col-last even-row-color">
87+
<div class="block">This package contains Hilt's built-in <a href="dagger/Component.html" title="annotation interface in dagger"><code>Component</code></a>s for Android.</div>
88+
</div>
89+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/flags/package-summary.html">dagger.hilt.android.flags</a></div>
90+
<div class="col-last odd-row-color">
91+
<div class="block">Runtime flags to control Hilt behavior for rollout of changes.</div>
92+
</div>
93+
<div class="col-first even-row-color"><a href="dagger/hilt/android/internal/builders/package-summary.html">dagger.hilt.android.internal.builders</a></div>
94+
<div class="col-last even-row-color">&nbsp;</div>
95+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/internal/lifecycle/package-summary.html">dagger.hilt.android.internal.lifecycle</a></div>
96+
<div class="col-last odd-row-color">&nbsp;</div>
97+
<div class="col-first even-row-color"><a href="dagger/hilt/android/internal/managers/package-summary.html">dagger.hilt.android.internal.managers</a></div>
98+
<div class="col-last even-row-color">&nbsp;</div>
99+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/internal/migration/package-summary.html">dagger.hilt.android.internal.migration</a></div>
100+
<div class="col-last odd-row-color">&nbsp;</div>
101+
<div class="col-first even-row-color"><a href="dagger/hilt/android/internal/modules/package-summary.html">dagger.hilt.android.internal.modules</a></div>
102+
<div class="col-last even-row-color">&nbsp;</div>
103+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/internal/testing/package-summary.html">dagger.hilt.android.internal.testing</a></div>
104+
<div class="col-last odd-row-color">&nbsp;</div>
105+
<div class="col-first even-row-color"><a href="dagger/hilt/android/internal/uninstallmodules/package-summary.html">dagger.hilt.android.internal.uninstallmodules</a></div>
106+
<div class="col-last even-row-color">&nbsp;</div>
107+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/lifecycle/package-summary.html">dagger.hilt.android.lifecycle</a></div>
108+
<div class="col-last odd-row-color">
109+
<div class="block">This package contains Hilt APIs for Android applications.</div>
110+
</div>
111+
<div class="col-first even-row-color"><a href="dagger/hilt/android/migration/package-summary.html">dagger.hilt.android.migration</a></div>
112+
<div class="col-last even-row-color">
113+
<div class="block">This package contains Android APIs to help migrating a codebase to Hilt.</div>
114+
</div>
115+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/qualifiers/package-summary.html">dagger.hilt.android.qualifiers</a></div>
116+
<div class="col-last odd-row-color">
117+
<div class="block">This package contains Hilt's built-in Android <code>Qualifier</code> annotations.</div>
118+
</div>
119+
<div class="col-first even-row-color"><a href="dagger/hilt/android/scopes/package-summary.html">dagger.hilt.android.scopes</a></div>
120+
<div class="col-last even-row-color">
121+
<div class="block">This package contains Hilt's built-in Android <code>Scope</code> annotations.</div>
122+
</div>
123+
<div class="col-first odd-row-color"><a href="dagger/hilt/android/testing/package-summary.html">dagger.hilt.android.testing</a></div>
124+
<div class="col-last odd-row-color">
125+
<div class="block">This package contains APIs for writing Android local or instrumentation tests with Hilt.</div>
126+
</div>
127+
<div class="col-first even-row-color"><a href="dagger/hilt/codegen/package-summary.html">dagger.hilt.codegen</a></div>
128+
<div class="col-last even-row-color">
129+
<div class="block">This package contains APIs for code generators that produce code that will be processed by Hilt.</div>
130+
</div>
131+
<div class="col-first odd-row-color"><a href="dagger/hilt/components/package-summary.html">dagger.hilt.components</a></div>
132+
<div class="col-last odd-row-color">
133+
<div class="block">This package contains Hilt's built-in <a href="dagger/Component.html" title="annotation interface in dagger"><code>Component</code></a>s.</div>
134+
</div>
135+
<div class="col-first even-row-color"><a href="dagger/hilt/internal/aliasof/package-summary.html">dagger.hilt.internal.aliasof</a></div>
136+
<div class="col-last even-row-color">&nbsp;</div>
137+
<div class="col-first odd-row-color"><a href="dagger/hilt/internal/definecomponent/package-summary.html">dagger.hilt.internal.definecomponent</a></div>
138+
<div class="col-last odd-row-color">&nbsp;</div>
139+
<div class="col-first even-row-color"><a href="dagger/hilt/internal/generatesrootinput/package-summary.html">dagger.hilt.internal.generatesrootinput</a></div>
140+
<div class="col-last even-row-color">&nbsp;</div>
141+
<div class="col-first odd-row-color"><a href="dagger/hilt/migration/package-summary.html">dagger.hilt.migration</a></div>
142+
<div class="col-last odd-row-color">
143+
<div class="block">This package contains APIs to help migrating a codebase to Hilt.</div>
144+
</div>
145+
<div class="col-first even-row-color"><a href="dagger/hilt/processor/internal/aggregateddeps/package-summary.html">dagger.hilt.processor.internal.aggregateddeps</a></div>
146+
<div class="col-last even-row-color">&nbsp;</div>
147+
<div class="col-first odd-row-color"><a href="dagger/hilt/testing/package-summary.html">dagger.hilt.testing</a></div>
148+
<div class="col-last odd-row-color">
149+
<div class="block">This package contains APIs for writing tests with Hilt.</div>
150+
</div>
151+
<div class="col-first even-row-color"><a href="dagger/model/package-summary.html">dagger.model</a></div>
152+
<div class="col-last even-row-color">
153+
<div class="block">This package contains the APIs that are core to Dagger's internal model of bindings and the
154+
binding graph.</div>
155+
</div>
156+
<div class="col-first odd-row-color"><a href="dagger/multibindings/package-summary.html">dagger.multibindings</a></div>
157+
<div class="col-last odd-row-color">
158+
<div class="block">This package contains the API by which Dagger allows you to bind several objects into a
159+
collection that can be injected without depending directly on each of the individual bindings.</div>
160+
</div>
161+
<div class="col-first even-row-color"><a href="dagger/producers/package-summary.html">dagger.producers</a></div>
162+
<div class="col-last even-row-color">
163+
<div class="block">This package contains the public API for Dagger 2's producer functionality.</div>
164+
</div>
165+
<div class="col-first odd-row-color"><a href="dagger/producers/monitoring/package-summary.html">dagger.producers.monitoring</a></div>
166+
<div class="col-last odd-row-color">
167+
<div class="block">This package provides hooks for monitoring producers.</div>
168+
</div>
169+
<div class="col-first even-row-color"><a href="dagger/spi/package-summary.html">dagger.spi</a></div>
170+
<div class="col-last even-row-color">
171+
<div class="block">This package contains the Service Provider interface (SPI) to the <a href="dagger/model/package-summary.html"><code>dagger.model</code></a> APIs at
172+
annotation-processing-time.</div>
173+
</div>
174+
<div class="col-first odd-row-color"><a href="dagger/spi/model/package-summary.html">dagger.spi.model</a></div>
175+
<div class="col-last odd-row-color">
176+
<div class="block">This package contains the APIs that are core to Dagger's internal model of bindings and the
177+
binding graph.</div>
178+
</div>
179+
</div>
180+
</main>
181+
</div>
182+
</div>
183+
</body>
184+
</html>

‎api/2.59.1/dagger/Binds.html‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) -->
5+
<title>Binds</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF8">
8+
<meta name="description" content="declaration: package: dagger, annotation type: Binds">
9+
<meta name="generator" content="javadoc/ClassWriterImpl">
10+
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
13+
<script type="text/javascript" src="../script.js"></script>
14+
<script type="text/javascript" src="../script-dir/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="class-declaration-page">
18+
<script type="text/javascript">var pathtoroot = "../";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top">
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="../index.html">Overview</a></li>
31+
<li><a href="package-summary.html">Package</a></li>
32+
<li class="nav-bar-cell1-rev">Class</li>
33+
<li><a href="class-use/Binds.html">Use</a></li>
34+
<li><a href="package-tree.html">Tree</a></li>
35+
<li><a href="../deprecated-list.html">Deprecated</a></li>
36+
<li><a href="../index-all.html">Index</a></li>
37+
<li><a href="../help-doc.html#class">Help</a></li>
38+
</ul>
39+
</div>
40+
<div class="sub-nav">
41+
<div>
42+
<ul class="sub-nav-list">
43+
<li>Summary:&nbsp;</li>
44+
<li>Field&nbsp;|&nbsp;</li>
45+
<li>Optional&nbsp;|&nbsp;</li>
46+
<li>Required</li>
47+
</ul>
48+
<ul class="sub-nav-list">
49+
<li>Detail:&nbsp;</li>
50+
<li>Field&nbsp;|&nbsp;</li>
51+
<li>Element</li>
52+
</ul>
53+
</div>
54+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
55+
<input type="text" id="search-input" value="search" disabled="disabled">
56+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
57+
</div>
58+
</div>
59+
<!-- ========= END OF TOP NAVBAR ========= -->
60+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
61+
</header>
62+
<div class="flex-content">
63+
<main role="main">
64+
<!-- ======== START OF CLASS DATA ======== -->
65+
<div class="header">
66+
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">dagger</a></div>
67+
<h1 title="Annotation Interface Binds" class="title">Annotation Interface Binds</h1>
68+
</div>
69+
<section class="class-description" id="class-description">
70+
<hr>
71+
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
72+
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
73+
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
74+
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">Binds</span></div>
75+
<div class="block">Annotates <em>abstract</em> methods of a <a href="Module.html" title="annotation interface in dagger"><code>Module</code></a> that delegate bindings. For example, to
76+
bind <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link"><code>Random</code></a> to <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/SecureRandom.html" title="class or interface in java.security" class="external-link"><code>SecureRandom</code></a> a module could declare the
77+
following: <code>@Binds abstract Random bindRandom(SecureRandom secureRandom);</code>
78+
79+
<p><code>@Binds</code> methods are a drop-in replacement for <a href="Provides.html" title="annotation interface in dagger"><code>Provides</code></a> methods that simply
80+
return an injected parameter. Prefer <code>@Binds</code> because the generated implementation is
81+
likely to be more efficient.
82+
83+
<p>A <code>@Binds</code> method:
84+
85+
<ul>
86+
<li>Must be <code>abstract</code>.
87+
<li>May be scoped.
88+
<li>May be qualified.
89+
<li>Must have a single parameter whose type is assignable to the return type. The return type
90+
declares the bound type (just as it would for a @<a href="Provides.html" title="annotation interface in dagger"><code>Provides</code></a> method)
91+
and the parameter is the type to which it is bound.
92+
<p>For <a href="multibindings/package-summary.html">multibindings</a>, assignability is checked in similar
93+
ways:
94+
<dl>
95+
<dt><a href="multibindings/IntoSet.html" title="annotation interface in dagger.multibindings"><code>IntoSet</code></a>
96+
<dd>The parameter must be assignable to the only parameter of <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#add(E)" title="class or interface in java.util" class="external-link"><code>Set.add(E)</code></a>
97+
when viewed as a member of the return type — the parameter must be assignable to the
98+
return type.
99+
<dt><a href="multibindings/ElementsIntoSet.html" title="annotation interface in dagger.multibindings"><code>ElementsIntoSet</code></a>
100+
<dd>The parameter must be assignable to the only parameter of <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#addAll(java.util.Collection)" title="class or interface in java.util" class="external-link"><code>Set.addAll(java.util.Collection&lt;? extends E&gt;)</code></a> when viewed as a member of the return type — if the return type
101+
is <code>Set&lt;E&gt;</code>, the parameter must be assignable to <code>Collection&lt;? extends
102+
E&gt;</code>.
103+
<dt><a href="multibindings/IntoMap.html" title="annotation interface in dagger.multibindings"><code>IntoMap</code></a>
104+
<dd>The parameter must be assignable to the <code>value</code> parameter of <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html#put(K,V)" title="class or interface in java.util" class="external-link"><code>Map.put(K, V)</code></a> when viewed as a member of a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> in which <code>
105+
V</code> is bound to the return type — the parameter must be assignable to the return type
106+
</dl>
107+
</ul></div>
108+
</section>
109+
<!-- ========= END OF CLASS DATA ========= -->
110+
</main>
111+
</div>
112+
</div>
113+
</body>
114+
</html>

0 commit comments

Comments
 (0)