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
|
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2003-2011, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
/** Represents a value of one of two possible types (a disjoint union).
* The data constructors [[scala.Left]] and [[scala.Right]] represent
* the two possible values.
* The `Either` type is often used as an alternative to [[scala.Option]]
* where `Left` represents failure (by convention) and `Right` is akin to `Some`.
*
* @author <a href="mailto:research@workingmouse.com">Tony Morris</a>, Workingmouse
* @version 1.0, 11/10/2008
* @since 2.7
*/
sealed abstract class Either[+A, +B] {
/**
* Projects this `Either` as a `Left`.
*/
def left = Either.LeftProjection(this)
/**
* Projects this `Either` as a `Right`.
*/
def right = Either.RightProjection(this)
/**
* Applies `fa` if this is a `Left` or `fb` if this is a `Right`.
*
* @param fa the function to apply if this is a `Left`
* @param fb the function to apply if this is a `Right`
* @return the results of applying the function
*/
def fold[X](fa: A => X, fb: B => X) = this match {
case Left(a) => fa(a)
case Right(b) => fb(b)
}
/**
* If this is a `Left`, then return the left value in `Right` or vice versa.
*/
def swap = this match {
case Left(a) => Right(a)
case Right(b) => Left(b)
}
/**
* Joins an `Either` through `Right`.
*/
def joinRight[A1 >: A, B1 >: B, C](implicit ev: B1 <:< Either[A1, C]): Either[A1, C] = this match {
case Left(a) => Left(a)
case Right(b) => b
}
/**
* Joins an `Either` through `Left`.
*/
def joinLeft[A1 >: A, B1 >: B, C](implicit ev: A1 <:< Either[C, B1]): Either[C, B1] = this match {
case Left(a) => a
case Right(b) => Right(b)
}
/**
* Returns `true` if this is a `Left`, `false` otherwise.
*/
def isLeft: Boolean
/**
* Returns `true` if this is a `Right`, `false` otherwise.
*/
def isRight: Boolean
}
/**
* The left side of the disjoint union, as opposed to the `Right` side.
*
* @author <a href="mailto:research@workingmouse.com">Tony Morris</a>, Workingmouse
* @version 1.0, 11/10/2008
*/
final case class Left[+A, +B](a: A) extends Either[A, B] {
def isLeft = true
def isRight = false
}
/**
* The right side of the disjoint union, as opposed to the `Left` side.
*
* @author <a href="mailto:research@workingmouse.com">Tony Morris</a>, Workingmouse
* @version 1.0, 11/10/2008
*/
final case class Right[+A, +B](b: B) extends Either[A, B] {
def isLeft = false
def isRight = true
}
object Either {
class MergeableEither[A](x: Either[A, A]) {
def merge: A = x match {
case Left(a) => a
case Right(a) => a
}
}
implicit def either2mergeable[A](x: Either[A, A]): MergeableEither[A] = new MergeableEither(x)
/**
* Projects an `Either` into a `Left`.
*
* @author <a href="mailto:research@workingmouse.com">Tony Morris</a>, Workingmouse
* @version 1.0, 11/10/2008
*/
final case class LeftProjection[+A, +B](e: Either[A, B]) {
/**
* Returns the value from this `Left` or throws `Predef.NoSuchElementException`
* if this is a `Right`.
*
* @throws Predef.NoSuchElementException if the option is empty.
*/
def get = e match {
case Left(a) => a
case Right(_) => throw new NoSuchElementException("Either.left.value on Right")
}
/**
* Executes the given side-effect if this is a `Left`.
*
* @param e The side-effect to execute.
*/
def foreach[U](f: A => U) = e match {
case Left(a) => f(a)
case Right(_) => {}
}
/**
* Returns the value from this `Left` or the given argument if this is a
* `Right`.
*/
def getOrElse[AA >: A](or: => AA) = e match {
case Left(a) => a
case Right(_) => or
}
/**
* Returns `true` if `Right` or returns the result of the application of
* the given function to the `Left` value.
*/
def forall(f: A => Boolean) = e match {
case Left(a) => f(a)
case Right(_) => true
}
/**
* Returns `false` if `Right` or returns the result of the application of
* the given function to the `Left` value.
*/
def exists(f: A => Boolean) = e match {
case Left(a) => f(a)
case Right(_) => false
}
/**
* Binds the given function across `Left`.
*
* @param The function to bind across `Left`.
*/
def flatMap[BB >: B, X](f: A => Either[X, BB]) = e match {
case Left(a) => f(a)
case Right(b) => Right(b)
}
/**
* Maps the function argument through `Left`.
*/
def map[X](f: A => X) = e match {
case Left(a) => Left(f(a))
case Right(b) => Right(b)
}
/**
* Returns `None` if this is a `Right` or if the given predicate
* `p` does not hold for the left value, otherwise, returns a `Left`.
*/
def filter[Y](p: A => Boolean): Option[Either[A, Y]] = e match {
case Left(a) => if(p(a)) Some(Left(a)) else None
case Right(b) => None
}
/**
* Returns a `Seq` containing the `Left` value if it exists or an empty
* `Seq` if this is a `Right`.
*/
def toSeq = e match {
case Left(a) => Seq(a)
case Right(_) => Seq.empty
}
/**
* Returns a `Some` containing the `Left` value if it exists or a
* `None` if this is a `Right`.
*/
def toOption = e match {
case Left(a) => Some(a)
case Right(_) => None
}
}
/**
* Projects an `Either` into a `Right`.
*
* @author <a href="mailto:research@workingmouse.com">Tony Morris</a>, Workingmouse
* @version 1.0, 11/10/2008
*/
final case class RightProjection[+A, +B](e: Either[A, B]) {
/**
* Returns the value from this `Right` or throws
* `Predef.NoSuchElementException` if this is a `Left`.
*
* @throws Predef.NoSuchElementException if the projection is `Left`.
*/
def get = e match {
case Left(_) => throw new NoSuchElementException("Either.right.value on Left")
case Right(a) => a
}
/**
* Executes the given side-effect if this is a `Right`.
*
* @param e The side-effect to execute.
*/
def foreach[U](f: B => U) = e match {
case Left(_) => {}
case Right(b) => f(b)
}
/**
* Returns the value from this `Right` or the given argument if this is a
* `Left`.
*/
def getOrElse[BB >: B](or: => BB) = e match {
case Left(_) => or
case Right(b) => b
}
/**
* Returns `true` if `Left` or returns the result of the application of
* the given function to the `Right` value.
*/
def forall(f: B => Boolean) = e match {
case Left(_) => true
case Right(b) => f(b)
}
/**
* Returns `false` if `Left` or returns the result of the application of
* the given function to the `Right` value.
*/
def exists(f: B => Boolean) = e match {
case Left(_) => false
case Right(b) => f(b)
}
/**
* Binds the given function across `Right`.
*
* @param The function to bind across `Right`.
*/
def flatMap[AA >: A, Y](f: B => Either[AA, Y]) = e match {
case Left(a) => Left(a)
case Right(b) => f(b)
}
/**
* Maps the function argument through `Right`.
*/
def map[Y](f: B => Y) = e match {
case Left(a) => Left(a)
case Right(b) => Right(f(b))
}
/** Returns `None` if this is a `Left` or if the
* given predicate `p` does not hold for the right value,
* otherwise, returns a `Right`.
*/
def filter[X](p: B => Boolean): Option[Either[X, B]] = e match {
case Left(_) => None
case Right(b) => if(p(b)) Some(Right(b)) else None
}
/** Returns a `Seq` containing the `Right` value if
* it exists or an empty `Seq` if this is a `Left`.
*/
def toSeq = e match {
case Left(_) => Seq.empty
case Right(b) => Seq(b)
}
/** Returns a `Some` containing the `Right` value
* if it exists or a `None` if this is a `Left`.
*/
def toOption = e match {
case Left(_) => None
case Right(b) => Some(b)
}
}
@deprecated("use `x.joinLeft'", "2.8.0")
def joinLeft[A, B](es: Either[Either[A, B], B]) =
es.left.flatMap(x => x)
@deprecated("use `x.joinRight'", "2.8.0")
def joinRight[A, B](es: Either[A, Either[A, B]]) =
es.right.flatMap(x => x)
/**
* Takes an `Either` to its contained value within `Left` or
* `Right`.
*/
@deprecated("use `x.merge'", "2.8.0")
def merge[T](e: Either[T, T]) = e match {
case Left(t) => t
case Right(t) => t
}
/** If the condition satisfies, return the given `A` in `Left`,
* otherwise, return the given `B` in `Right`.
*/
def cond[A, B](test: Boolean, right: => B, left: => A): Either[A, B] =
if (test) Right(right) else Left(left)
}
|