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
|
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2006-2013, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://www.scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
package collection
package convert
import java.{ lang => jl, util => ju }, java.util.{ concurrent => juc }
import Decorators._
import WrapAsJava._
import scala.language.implicitConversions
/** A collection of decorators that allow converting between
* Scala and Java collections using `asScala` and `asJava` methods.
*
* The following conversions are supported via `asJava`, `asScala`
*
* - `scala.collection.Iterable` <=> `java.lang.Iterable`
* - `scala.collection.Iterator` <=> `java.util.Iterator`
* - `scala.collection.mutable.Buffer` <=> `java.util.List`
* - `scala.collection.mutable.Set` <=> `java.util.Set`
* - `scala.collection.mutable.Map` <=> `java.util.Map`
* - `scala.collection.mutable.concurrent.Map` <=> `java.util.concurrent.ConcurrentMap`
*
* In all cases, converting from a source type to a target type and back
* again will return the original source object, e.g.
* {{{
* import scala.collection.JavaConverters._
*
* val sl = new scala.collection.mutable.ListBuffer[Int]
* val jl : java.util.List[Int] = sl.asJava
* val sl2 : scala.collection.mutable.Buffer[Int] = jl.asScala
* assert(sl eq sl2)
* }}}
* The following conversions are also supported, but the
* direction from Scala to Java is done by the more specifically named methods:
* `asJavaCollection`, `asJavaEnumeration`, `asJavaDictionary`.
*
* - `scala.collection.Iterable` <=> `java.util.Collection`
* - `scala.collection.Iterator` <=> `java.util.Enumeration`
* - `scala.collection.mutable.Map` <=> `java.util.Dictionary`
*
* In addition, the following one way conversions are provided via `asJava`:
*
* - `scala.collection.Seq` => `java.util.List`
* - `scala.collection.mutable.Seq` => `java.util.List`
* - `scala.collection.Set` => `java.util.Set`
* - `scala.collection.Map` => `java.util.Map`
*
* The following one way conversion is provided via `asScala`:
*
* - `java.util.Properties` => `scala.collection.mutable.Map`
*
* @since 2.8.1
*/
trait DecorateAsJava {
/**
* Adds an `asJava` method that implicitly converts a Scala `Iterator` to a
* Java `Iterator`. The returned Java `Iterator` is backed by the provided Scala
* `Iterator` and any side-effects of using it via the Java interface will
* be visible via the Scala interface and vice versa.
*
* If the Scala `Iterator` was previously obtained from an implicit or explicit
* call of `asIterator(java.util.Iterator)` then the original Java `Iterator`
* will be returned by the `asJava` method.
*
* @param i The `Iterator` to be converted.
* @return An object with an `asJava` method that returns a Java `Iterator` view of the argument.
*/
implicit def asJavaIteratorConverter[A](i : Iterator[A]): AsJava[ju.Iterator[A]] =
new AsJava(asJavaIterator(i))
/**
* Adds an `asJavaEnumeration` method that implicitly converts a Scala
* `Iterator` to a Java `Enumeration`. The returned Java `Enumeration` is
* backed by the provided Scala `Iterator` and any side-effects of using
* it via the Java interface will be visible via the Scala interface and
* vice versa.
*
* If the Scala `Iterator` was previously obtained from an implicit or
* explicit call of `asIterator(java.util.Enumeration)` then the
* original Java `Enumeration` will be returned.
*
* @param i The `Iterator` to be converted.
* @return An object with an `asJavaEnumeration` method that returns a Java
* `Enumeration` view of the argument.
*/
implicit def asJavaEnumerationConverter[A](i : Iterator[A]): AsJavaEnumeration[A] =
new AsJavaEnumeration(i)
/**
* Adds an `asJava` method that implicitly converts a Scala `Iterable` to
* a Java `Iterable`.
*
* The returned Java `Iterable` is backed by the provided Scala `Iterable`
* and any side-effects of using it via the Java interface will be visible
* via the Scala interface and vice versa.
*
* If the Scala `Iterable` was previously obtained from an implicit or
* explicit call of `asIterable(java.lang.Iterable)` then the original
* Java `Iterable` will be returned.
*
* @param i The `Iterable` to be converted.
* @return An object with an `asJavaCollection` method that returns a Java
* `Iterable` view of the argument.
*/
implicit def asJavaIterableConverter[A](i : Iterable[A]): AsJava[jl.Iterable[A]] =
new AsJava(asJavaIterable(i))
/**
* Adds an `asJavaCollection` method that implicitly converts a Scala
* `Iterable` to an immutable Java `Collection`.
*
* If the Scala `Iterable` was previously obtained from an implicit or
* explicit call of `asSizedIterable(java.util.Collection)` then the
* original Java `Collection` will be returned.
*
* @param i The `SizedIterable` to be converted.
* @return An object with an `asJava` method that returns a Java
* `Collection` view of the argument.
*/
implicit def asJavaCollectionConverter[A](i : Iterable[A]): AsJavaCollection[A] =
new AsJavaCollection(i)
/**
* Adds an `asJava` method that implicitly converts a Scala mutable `Buffer`
* to a Java `List`.
*
* The returned Java `List` is backed by the provided Scala `Buffer` and any
* side-effects of using it via the Java interface will be visible via the
* Scala interface and vice versa.
*
* If the Scala `Buffer` was previously obtained from an implicit or explicit
* call of `asBuffer(java.util.List)` then the original Java `List` will be
* returned.
*
* @param b The `Buffer` to be converted.
* @return An object with an `asJava` method that returns a Java `List` view
* of the argument.
*/
implicit def bufferAsJavaListConverter[A](b : mutable.Buffer[A]): AsJava[ju.List[A]] =
new AsJava(bufferAsJavaList(b))
/**
* Adds an `asJava` method that implicitly converts a Scala mutable `Seq`
* to a Java `List`.
*
* The returned Java `List` is backed by the provided Scala `Seq` and any
* side-effects of using it via the Java interface will be visible via the
* Scala interface and vice versa.
*
* If the Scala `Seq` was previously obtained from an implicit or explicit
* call of `asSeq(java.util.List)` then the original Java `List` will be
* returned.
*
* @param b The `Seq` to be converted.
* @return An object with an `asJava` method that returns a Java `List`
* view of the argument.
*/
implicit def mutableSeqAsJavaListConverter[A](b : mutable.Seq[A]): AsJava[ju.List[A]] =
new AsJava(mutableSeqAsJavaList(b))
/**
* Adds an `asJava` method that implicitly converts a Scala `Seq` to a
* Java `List`.
*
* The returned Java `List` is backed by the provided Scala `Seq` and any
* side-effects of using it via the Java interface will be visible via the
* Scala interface and vice versa.
*
* If the Scala `Seq` was previously obtained from an implicit or explicit
* call of `asSeq(java.util.List)` then the original Java `List` will be
* returned.
*
* @param b The `Seq` to be converted.
* @return An object with an `asJava` method that returns a Java `List`
* view of the argument.
*/
implicit def seqAsJavaListConverter[A](b : Seq[A]): AsJava[ju.List[A]] =
new AsJava(seqAsJavaList(b))
/**
* Adds an `asJava` method that implicitly converts a Scala mutable `Set`>
* to a Java `Set`.
*
* The returned Java `Set` is backed by the provided Scala `Set` and any
* side-effects of using it via the Java interface will be visible via
* the Scala interface and vice versa.
*
* If the Scala `Set` was previously obtained from an implicit or explicit
* call of `asSet(java.util.Set)` then the original Java `Set` will be
* returned.
*
* @param s The `Set` to be converted.
* @return An object with an `asJava` method that returns a Java `Set` view
* of the argument.
*/
implicit def mutableSetAsJavaSetConverter[A](s : mutable.Set[A]): AsJava[ju.Set[A]] =
new AsJava(mutableSetAsJavaSet(s))
/**
* Adds an `asJava` method that implicitly converts a Scala `Set` to a
* Java `Set`.
*
* The returned Java `Set` is backed by the provided Scala `Set` and any
* side-effects of using it via the Java interface will be visible via
* the Scala interface and vice versa.
*
* If the Scala `Set` was previously obtained from an implicit or explicit
* call of `asSet(java.util.Set)` then the original Java `Set` will be
* returned.
*
* @param s The `Set` to be converted.
* @return An object with an `asJava` method that returns a Java `Set` view
* of the argument.
*/
implicit def setAsJavaSetConverter[A](s : Set[A]): AsJava[ju.Set[A]] =
new AsJava(setAsJavaSet(s))
/**
* Adds an `asJava` method that implicitly converts a Scala mutable `Map`
* to a Java `Map`.
*
* The returned Java `Map` is backed by the provided Scala `Map` and any
* side-effects of using it via the Java interface will be visible via the
* Scala interface and vice versa.
*
* If the Scala `Map` was previously obtained from an implicit or explicit
* call of `asMap(java.util.Map)` then the original Java `Map` will be
* returned.
*
* @param m The `Map` to be converted.
* @return An object with an `asJava` method that returns a Java `Map` view
* of the argument.
*/
implicit def mutableMapAsJavaMapConverter[A, B](m : mutable.Map[A, B]): AsJava[ju.Map[A, B]] =
new AsJava(mutableMapAsJavaMap(m))
/**
* Adds an `asJavaDictionary` method that implicitly converts a Scala
* mutable `Map` to a Java `Dictionary`.
*
* The returned Java `Dictionary` is backed by the provided Scala
* `Dictionary` and any side-effects of using it via the Java interface
* will be visible via the Scala interface and vice versa.
*
* If the Scala `Dictionary` was previously obtained from an implicit or
* explicit call of `asMap(java.util.Dictionary)` then the original
* Java `Dictionary` will be returned.
*
* @param m The `Map` to be converted.
* @return An object with an `asJavaDictionary` method that returns a
* Java `Dictionary` view of the argument.
*/
implicit def asJavaDictionaryConverter[A, B](m : mutable.Map[A, B]): AsJavaDictionary[A, B] =
new AsJavaDictionary(m)
/**
* Adds an `asJava` method that implicitly converts a Scala `Map` to
* a Java `Map`.
*
* The returned Java `Map` is backed by the provided Scala `Map` and any
* side-effects of using it via the Java interface will be visible via
* the Scala interface and vice versa.
*
* If the Scala `Map` was previously obtained from an implicit or explicit
* call of `asMap(java.util.Map)` then the original Java `Map` will be
* returned.
*
* @param m The `Map` to be converted.
* @return An object with an `asJava` method that returns a Java `Map` view
* of the argument.
*/
implicit def mapAsJavaMapConverter[A, B](m : Map[A, B]): AsJava[ju.Map[A, B]] =
new AsJava(mapAsJavaMap(m))
/**
* Adds an `asJava` method that implicitly converts a Scala mutable
* `concurrent.Map` to a Java `ConcurrentMap`.
*
* The returned Java `ConcurrentMap` is backed by the provided Scala
* `concurrent.Map` and any side-effects of using it via the Java interface
* will be visible via the Scala interface and vice versa.
*
* If the Scala `concurrent.Map` was previously obtained from an implicit or
* explicit call of `asConcurrentMap(java.util.concurrent.ConcurrentMap)`
* then the original Java `ConcurrentMap` will be returned.
*
* @param m The Scala `concurrent.Map` to be converted.
* @return An object with an `asJava` method that returns a Java
* `ConcurrentMap` view of the argument.
*/
implicit def mapAsJavaConcurrentMapConverter[A, B](m: concurrent.Map[A, B]): AsJava[juc.ConcurrentMap[A, B]] =
new AsJava(mapAsJavaConcurrentMap(m))
}
|
