1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_65) on Sun Oct 25 13:26:03 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ListBinder (Sangria 1.3.1 API)</title>
<meta name="date" content="2015-10-25">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ListBinder (Sangria 1.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ListBinder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/tavianator/sangria/listbinder/AnnotatedListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../com/tavianator/sangria/listbinder/ListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/tavianator/sangria/listbinder/ListBinder.html" target="_top">Frames</a></li>
<li><a href="ListBinder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.tavianator.sangria.listbinder</div>
<h2 title="Class ListBinder" class="title">Class ListBinder<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.tavianator.sangria.listbinder.ListBinder<T></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of the list element.</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ListBinder<T></span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A multi-binder with guaranteed order.
<p>
<a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a> is much like <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/multibindings/Multibinder.html?is-external=true" title="class or interface in com.google.inject.multibindings"><code>Multibinder</code></a>, except it provides a guaranteed iteration order, and binds a
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> instead of a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a>. For example:
</p>
<pre>
ListBinder<String> listBinder = ListBinder.build(binder(), String.class)
.withDefaultPriority();
listBinder.addBinding().toInstance("a");
listBinder.addBinding().toInstance("b");
</pre>
<p>
This will create a binding for a <code>List<String></code>, which contains <code>"a"</code> followed by <code>"b"</code>. It also
creates a binding for <code>List<Provider<String>></code> — this may be useful in more advanced cases to allow list
elements to be lazily loaded.
</p>
<p>To add an annotation to the list binding, simply write this:</p>
<pre>
ListBinder<String> listBinder = ListBinder.build(binder(), String.class)
.annotatedWith(Names.named("name"))
.withDefaultPriority();
</pre>
<p>
and the created binding will be <code>@Named("name") List<String></code> instead.
</p>
<p>
For large lists, it may be helpful to split up their specification across different modules. This is accomplished by
specifying <em>priorities</em> for the <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>s when they are created. For example:
</p>
<pre>
// In some module
ListBinder<String> listBinder1 = ListBinder.build(binder(), String.class)
.withPriority(0);
listBinder1.addBinding().toInstance("a");
listBinder1.addBinding().toInstance("b");
// ... some other module
ListBinder<String> listBinder2 = ListBinder.build(binder(), String.class)
.withPriority(1);
listBinder2.addBinding().toInstance("c");
listBinder2.addBinding().toInstance("d");
</pre>
<p>
The generated list will contain <code>"a"</code>, <code>"b"</code>, <code>"c"</code>, <code>"d"</code>, in order. This happens because
the first <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a> had a smaller priority, so its entries come first. For more information about the
priority system, see <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core"><code>Priority</code></a>.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>1.1</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Tavian Barnes (tavianator@tavianator.com)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/binder/LinkedBindingBuilder.html?is-external=true" title="class or interface in com.google.inject.binder">LinkedBindingBuilder</a><<a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="type parameter in ListBinder">T</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html#addBinding--">addBinding</a></span>()</code>
<div class="block">Add an entry to the list.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <T> <a href="../../../../com/tavianator/sangria/listbinder/AnnotatedListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder">AnnotatedListBinderBuilder</a><T></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html#build-com.google.inject.Binder-java.lang.Class-">build</a></span>(<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/Binder.html?is-external=true" title="class or interface in com.google.inject">Binder</a> binder,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code>
<div class="block">Start building a <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <T> <a href="../../../../com/tavianator/sangria/listbinder/AnnotatedListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder">AnnotatedListBinderBuilder</a><T></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html#build-com.google.inject.Binder-com.google.inject.TypeLiteral-">build</a></span>(<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/Binder.html?is-external=true" title="class or interface in com.google.inject">Binder</a> binder,
<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/TypeLiteral.html?is-external=true" title="class or interface in com.google.inject">TypeLiteral</a><T> type)</code>
<div class="block">Start building a <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html#toString--">toString</a></span>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="build-com.google.inject.Binder-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public static <T> <a href="../../../../com/tavianator/sangria/listbinder/AnnotatedListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder">AnnotatedListBinderBuilder</a><T> build(<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/Binder.html?is-external=true" title="class or interface in com.google.inject">Binder</a> binder,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</pre>
<div class="block">Start building a <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of the list element.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - The current binder, usually <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/AbstractModule.html?is-external=true#binder--" title="class or interface in com.google.inject"><code>AbstractModule.binder()</code></a>.</dd>
<dd><code>type</code> - The type of the list element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A fluent builder.</dd>
</dl>
</li>
</ul>
<a name="build-com.google.inject.Binder-com.google.inject.TypeLiteral-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public static <T> <a href="../../../../com/tavianator/sangria/listbinder/AnnotatedListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder">AnnotatedListBinderBuilder</a><T> build(<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/Binder.html?is-external=true" title="class or interface in com.google.inject">Binder</a> binder,
<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/TypeLiteral.html?is-external=true" title="class or interface in com.google.inject">TypeLiteral</a><T> type)</pre>
<div class="block">Start building a <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of the list element.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - The current binder, usually <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/AbstractModule.html?is-external=true#binder--" title="class or interface in com.google.inject"><code>AbstractModule.binder()</code></a>.</dd>
<dd><code>type</code> - The type of the list element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A fluent builder.</dd>
</dl>
</li>
</ul>
<a name="addBinding--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBinding</h4>
<pre>public <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/binder/LinkedBindingBuilder.html?is-external=true" title="class or interface in com.google.inject.binder">LinkedBindingBuilder</a><<a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="type parameter in ListBinder">T</a>> addBinding()</pre>
<div class="block">Add an entry to the list.
<p>
The entry will be added in order for this <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a> instance. Between different <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>s, the
order is determined by the <a href="../../../../com/tavianator/sangria/listbinder/ListBinder.html" title="class in com.tavianator.sangria.listbinder"><code>ListBinder</code></a>'s <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core"><code>Priority</code></a>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A fluent binding builder.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ListBinder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/tavianator/sangria/listbinder/AnnotatedListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../com/tavianator/sangria/listbinder/ListBinderBuilder.html" title="interface in com.tavianator.sangria.listbinder"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/tavianator/sangria/listbinder/ListBinder.html" target="_top">Frames</a></li>
<li><a href="ListBinder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014–2015. All rights reserved.</small></p>
</body>
</html>
|
