-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathEither.html
594 lines (594 loc) · 30.3 KB
/
Either.html
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
<!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 (version 1.7.0_45) on Mon Dec 15 00:47:59 EST 2014 -->
<title>Either</title>
<meta name="date" content="2014-12-15">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Either";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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="../../fj/data/Conversions.html" title="class in fj.data"><span class="strong">Prev Class</span></a></li>
<li><a href="../../fj/data/Either.LeftProjection.html" title="class in fj.data"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?fj/data/Either.html" target="_top">Frames</a></li>
<li><a href="Either.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><a href="#nested_class_summary">Nested</a> | </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">fj.data</div>
<h2 title="Class Either" class="title">Class Either<A,B></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>fj.data.Either<A,B></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="strong">Either<A,B></span>
extends java.lang.Object</pre>
<div class="block">The <code>Either</code> type represents a value of one of two possible types (a disjoint union).
The data constructors; <code>Left</code> and <code>Right</code> represent the two possible
values. The <code>Either</code> type is often used as an alternative to
<code>scala.Option</code> where <code>Left</code> represents failure (by convention) and
<code>Right</code> is akin to <code>Some</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.LeftProjection.html" title="class in fj.data">Either.LeftProjection</a><<a href="../../fj/data/Either.LeftProjection.html" title="type parameter in Either.LeftProjection">A</a>,<a href="../../fj/data/Either.LeftProjection.html" title="type parameter in Either.LeftProjection">B</a>></strong></code>
<div class="block">A left projection of an either value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.RightProjection.html" title="class in fj.data">Either.RightProjection</a><<a href="../../fj/data/Either.RightProjection.html" title="type parameter in Either.RightProjection">A</a>,<a href="../../fj/data/Either.RightProjection.html" title="type parameter in Either.RightProjection">B</a>></strong></code>
<div class="block">A right projection of an either value.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><X> X</code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#either(fj.F, fj.F)">either</a></strong>(<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>,X> left,
<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>,X> right)</code>
<div class="block">The catamorphism for either.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#iif(boolean, fj.P1, fj.P1)">iif</a></strong>(boolean c,
<a href="../../fj/P1.html" title="class in fj">P1</a><B> right,
<a href="../../fj/P1.html" title="class in fj">P1</a><A> left)</code>
<div class="block">If the condition satisfies, return the given A in left, otherwise, return the given B in right.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#isLeft()">isLeft</a></strong>()</code>
<div class="block">Returns <code>true</code> if this either is a left, <code>false</code> otherwise.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#isRight()">isRight</a></strong>()</code>
<div class="block">Returns <code>true</code> if this either is a right, <code>false</code> otherwise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#joinLeft(fj.data.Either)">joinLeft</a></strong>(<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>,B> e)</code>
<div class="block">Joins an either through left.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#joinRight(fj.data.Either)">joinRight</a></strong>(<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> e)</code>
<div class="block">Joins an either through right.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><A,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#left_()">left_</a></strong>()</code>
<div class="block">A function that constructs a left value of either.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../fj/data/Either.LeftProjection.html" title="class in fj.data">Either.LeftProjection</a><<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>,<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#left()">left</a></strong>()</code>
<div class="block">Projects this either as a left.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#left(A)">left</a></strong>(A a)</code>
<div class="block">Construct a left value of either.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,B,X> <a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/F.html" title="class in fj">F</a><A,X>,<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><X,B>>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#leftMap_()">leftMap_</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/List.html" title="class in fj.data">List</a><A></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#lefts(fj.data.List)">lefts</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> es)</code>
<div class="block">Returns all the left values in the given list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A> A</code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#reduce(fj.data.Either)">reduce</a></strong>(<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,A> e)</code>
<div class="block">Takes an <code>Either</code> to its contained value within left or right.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><B,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#right_()">right_</a></strong>()</code>
<div class="block">A function that constructs a right value of either.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../fj/data/Either.RightProjection.html" title="class in fj.data">Either.RightProjection</a><<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>,<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#right()">right</a></strong>()</code>
<div class="block">Projects this either as a right.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#right(B)">right</a></strong>(B b)</code>
<div class="block">Construct a right value of either.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,B,X> <a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/F.html" title="class in fj">F</a><B,X>,<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,X>>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#rightMap_()">rightMap_</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <A,B> <a href="../../fj/data/List.html" title="class in fj.data">List</a><B></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#rights(fj.data.List)">rights</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> es)</code>
<div class="block">Returns all the right values in the given list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <A,X> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><<a href="../../fj/data/List.html" title="class in fj.data">List</a><A>,X></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#sequenceLeft(fj.data.List)">sequenceLeft</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,X>> a)</code>
<div class="block">Sequences through the left side of the either monad with a list of values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <B,X> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><X,<a href="../../fj/data/List.html" title="class in fj.data">List</a><B>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#sequenceRight(fj.data.List)">sequenceRight</a></strong>(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><X,B>> a)</code>
<div class="block">Sequences through the right side of the either monad with a list of values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../fj/data/Either.html" title="class in fj.data">Either</a><<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>,<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>></code></td>
<td class="colLast"><code><strong><a href="../../fj/data/Either.html#swap()">swap</a></strong>()</code>
<div class="block">If this is a left, then return the left value in right, or vice versa.</div>
</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="left()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>left</h4>
<pre>public final <a href="../../fj/data/Either.LeftProjection.html" title="class in fj.data">Either.LeftProjection</a><<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>,<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>> left()</pre>
<div class="block">Projects this either as a left.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A left projection of this either.</dd></dl>
</li>
</ul>
<a name="right()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>right</h4>
<pre>public final <a href="../../fj/data/Either.RightProjection.html" title="class in fj.data">Either.RightProjection</a><<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>,<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>> right()</pre>
<div class="block">Projects this either as a right.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A right projection of this either.</dd></dl>
</li>
</ul>
<a name="isLeft()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLeft</h4>
<pre>public abstract boolean isLeft()</pre>
<div class="block">Returns <code>true</code> if this either is a left, <code>false</code> otherwise.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this either is a left, <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="isRight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRight</h4>
<pre>public abstract boolean isRight()</pre>
<div class="block">Returns <code>true</code> if this either is a right, <code>false</code> otherwise.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this either is a right, <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="either(fj.F, fj.F)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>either</h4>
<pre>public final <X> X either(<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>,X> left,
<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>,X> right)</pre>
<div class="block">The catamorphism for either. Folds over this either breaking into left or right.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - The function to call if this is left.</dd><dd><code>right</code> - The function to call if this is right.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The reduced value.</dd></dl>
</li>
</ul>
<a name="swap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>swap</h4>
<pre>public final <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><<a href="../../fj/data/Either.html" title="type parameter in Either">B</a>,<a href="../../fj/data/Either.html" title="type parameter in Either">A</a>> swap()</pre>
<div class="block">If this is a left, then return the left value in right, or vice versa.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The value of this either swapped to the opposing side.</dd></dl>
</li>
</ul>
<a name="left(java.lang.Object)">
<!-- -->
</a><a name="left(A)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>left</h4>
<pre>public static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B> left(A a)</pre>
<div class="block">Construct a left value of either.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - The value underlying the either.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A left value of either.</dd></dl>
</li>
</ul>
<a name="left_()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>left_</h4>
<pre>public static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><A,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> left_()</pre>
<div class="block">A function that constructs a left value of either.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A function that constructs a left value of either.</dd></dl>
</li>
</ul>
<a name="right_()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>right_</h4>
<pre>public static <A,B> <a href="../../fj/F.html" title="class in fj">F</a><B,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> right_()</pre>
<div class="block">A function that constructs a right value of either.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A function that constructs a right value of either.</dd></dl>
</li>
</ul>
<a name="right(java.lang.Object)">
<!-- -->
</a><a name="right(B)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>right</h4>
<pre>public static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B> right(B b)</pre>
<div class="block">Construct a right value of either.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - The value underlying the either.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A right value of either.</dd></dl>
</li>
</ul>
<a name="leftMap_()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>leftMap_</h4>
<pre>public static <A,B,X> <a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/F.html" title="class in fj">F</a><A,X>,<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><X,B>>> leftMap_()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>A function that maps another function across an either's left projection.</dd></dl>
</li>
</ul>
<a name="rightMap_()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rightMap_</h4>
<pre>public static <A,B,X> <a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/F.html" title="class in fj">F</a><B,X>,<a href="../../fj/F.html" title="class in fj">F</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,X>>> rightMap_()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>A function that maps another function across an either's right projection.</dd></dl>
</li>
</ul>
<a name="joinLeft(fj.data.Either)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinLeft</h4>
<pre>public static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B> joinLeft(<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>,B> e)</pre>
<div class="block">Joins an either through left.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - The either of either to join.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An either after joining.</dd></dl>
</li>
</ul>
<a name="joinRight(fj.data.Either)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinRight</h4>
<pre>public static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B> joinRight(<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> e)</pre>
<div class="block">Joins an either through right.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - The either of either to join.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An either after joining.</dd></dl>
</li>
</ul>
<a name="sequenceLeft(fj.data.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sequenceLeft</h4>
<pre>public static <A,X> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><<a href="../../fj/data/List.html" title="class in fj.data">List</a><A>,X> sequenceLeft(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,X>> a)</pre>
<div class="block">Sequences through the left side of the either monad with a list of values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - The list of values to sequence with the either monad.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A sequenced value.</dd></dl>
</li>
</ul>
<a name="sequenceRight(fj.data.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sequenceRight</h4>
<pre>public static <B,X> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><X,<a href="../../fj/data/List.html" title="class in fj.data">List</a><B>> sequenceRight(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><X,B>> a)</pre>
<div class="block">Sequences through the right side of the either monad with a list of values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - The list of values to sequence with the either monad.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A sequenced value.</dd></dl>
</li>
</ul>
<a name="reduce(fj.data.Either)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reduce</h4>
<pre>public static <A> A reduce(<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,A> e)</pre>
<div class="block">Takes an <code>Either</code> to its contained value within left or right.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - The either to reduce.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An <code>Either</code> to its contained value within left or right.</dd></dl>
</li>
</ul>
<a name="iif(boolean, fj.P1, fj.P1)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iif</h4>
<pre>public static <A,B> <a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B> iif(boolean c,
<a href="../../fj/P1.html" title="class in fj">P1</a><B> right,
<a href="../../fj/P1.html" title="class in fj">P1</a><A> left)</pre>
<div class="block">If the condition satisfies, return the given A in left, otherwise, return the given B in right.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - The condition to test.</dd><dd><code>right</code> - The right value to use if the condition satisfies.</dd><dd><code>left</code> - The left value to use if the condition does not satisfy.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A constructed either based on the given condition.</dd></dl>
</li>
</ul>
<a name="lefts(fj.data.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lefts</h4>
<pre>public static <A,B> <a href="../../fj/data/List.html" title="class in fj.data">List</a><A> lefts(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> es)</pre>
<div class="block">Returns all the left values in the given list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>es</code> - The list of possible left values.</dd>
<dt><span class="strong">Returns:</span></dt><dd>All the left values in the given list.</dd></dl>
</li>
</ul>
<a name="rights(fj.data.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rights</h4>
<pre>public static <A,B> <a href="../../fj/data/List.html" title="class in fj.data">List</a><B> rights(<a href="../../fj/data/List.html" title="class in fj.data">List</a><<a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B>> es)</pre>
<div class="block">Returns all the right values in the given list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>es</code> - The list of possible right values.</dd>
<dt><span class="strong">Returns:</span></dt><dd>All the right values in the given list.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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="../../fj/data/Conversions.html" title="class in fj.data"><span class="strong">Prev Class</span></a></li>
<li><a href="../../fj/data/Either.LeftProjection.html" title="class in fj.data"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?fj/data/Either.html" target="_top">Frames</a></li>
<li><a href="Either.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><a href="#nested_class_summary">Nested</a> | </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 ======= -->
</body>
</html>