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
|
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2003-2009, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
// $Id: Buffer.scala 15799 2008-08-15 18:23:54Z odersky $
package scalax.collection.mutable
import generic.mutable.VectorTemplate
/** Buffers are used to create sequences of elements incrementally by
* appending, prepending, or inserting new elements. It is also
* possible to access and modify elements in a random access fashion
* via the index of the element in the current sequence.
*
* @author Matthias Zenger
* @author Martin Odersky
* @version 2.8
*/
@cloneable
trait Buffer[A] extends Vector[A] with VectorTemplate[Buffer, A] with Appendable[A]
// with Scriptable[Message[(Location, A)]]
with CloneableCollection
{
// Abstract methods from Vector:
/** Return element at index `n`
* @throws IndexOutofBoundsException if the index is not valid
*/
def apply(n: Int): A
/** Return number of elements in the buffer
*/
def length: Int
/** Create a new buffer of the same kind as this one */
def newBuilder[B]: Builder[Buffer, B] = new ArrayBuffer[B]
/** Replace element at index <code>n</code> with the new element
* <code>newelem</code>.
*
* @param n the index of the element to replace.
* @param newelem the new element.
* @throws IndexOutofBoundsException if the index is not valid
*/
def update(n: Int, newelem: A): Unit
// Abstract methods from Appendable
/** Append a single element to this buffer.
*
* @param elem the element to append.
*/
def +=(elem: A): Unit
/** Clears the buffer contents.
*/
def clear()
// Abstract methods new in this class
/** Prepend a single element to this buffer and return
* the identity of the buffer.
* @param elem the element to prepend.
*/
def +:(elem: A): this.type
/** Inserts new elements at the index <code>n</code>. Opposed to method
* <code>update</code>, this method will not replace an element with a
* one. Instead, it will insert a new element at index <code>n</code>.
*
* @param n the index where a new element will be inserted.
* @param iter the iterable object providing all elements to insert.
* @throws IndexOutofBoundsException if the index is not valid
*/
def insertAll(n: Int, iter: Iterable[A]): Unit
/** Removes a number of elements from a given index position.
*
* @param n the index which refers to the element to delete.
* @param count the number of elements to delete
* @throws IndexOutofBoundsException if the index is not valid
*/
def remove(n: Int, count: Int): Unit
// Concrete methods
/** Removes the element on a given index position.
*
* @param n the index which refers to the element to delete.
*/
def remove(n: Int): A = {
val elem = this(n)
remove(n, 1)
elem
}
/** Removes a single element from this buffer, at its first occurrence.
* If the list does not contain that element, it is unchanged
*
* @param x the element to remove.
*/
def -= (x: A) {
val i = indexOf(x)
if (i != -1) remove(i)
}
/** Removes a single element from this buffer, at its first occurrence,
* and returns the identity of the buffer.
* If the buffer does not contain that element, it is unchanged
*
* @param x the element to remove.
*/
def - (x: A): this.type = { -=(x); this }
/** Prepend two ore more elements to this buffer and return
* the identity of the buffer.
* @param elem the element to prepend.
*/
def +:(elem1: A, elem2: A, elems: A*): this.type =
elem1 +: elem2 +: (elems.asInstanceOf[Iterable[A]]) ++: this // !@!
/** Prepends a number of elements provided by an iterable object
* via its <code>elements</code> method. The identity of the
* buffer is returned.
*
* @param iter the iterable object.
*/
def ++:(iter: Iterable[A]): this.type = { for (x <- iter) x +: this; this }
/** Prepends a number of elements provided by an iterator
* The identity of the buffer is returned.
*
* @param iter the iterator
* @return the updated buffer.
*/
def ++:(iter: Iterator[A]): this.type = { for (x <- iter) x +: this; this }
/** Appends a elements to this buffer.
*
* @param elems the elements to append.
*/
def append(elems: A*) { this ++= elems.asInstanceOf[Iterable[A]] } // !@!
/** Appends a number of elements provided by an iterable object
* via its <code>elements</code> method.
*
* @param iter the iterable object.
*/
def appendAll(iter: Iterable[A]) { this ++= iter }
/** Prepend given elements to this list.
*
* @param elem the element to prepend.
*/
def prepend(elems: A*) { elems.asInstanceOf[Iterable[A]] ++: this } // !@!
/** Prepends a number of elements provided by an iterable object
* via its <code>elements</code> method. The identity of the
* buffer is returned.
*
* @param iter the iterable object.
*/
def prependAll(iter: Iterable[A]) { iter ++: this }
/** Prepends a number of elements provided by an iterable object
* via its <code>elements</code> method. The identity of the
* buffer is returned.
*
* @param iter the iterable object.
*/
def prependAll(iter: Iterator[A]) { iter ++: this }
/** Inserts new elements at the index <code>n</code>. Opposed to method
* <code>update</code>, this method will not replace an element with a
* one. Instead, it will insert the new elements at index <code>n</code>.
*
* @param n the index where a new element will be inserted.
* @param elems the new elements to insert.
*/
def insert(n: Int, elems: A*) { insertAll(n, elems.asInstanceOf[Iterable[A]]) } // !@!
/** Removes the first <code>n</code> elements.
*
* @param n the number of elements to remove from the beginning
* of this buffer.
*/
def trimStart(n: Int) { remove(0, n) }
/** Removes the last <code>n</code> elements.
*
* @param n the number of elements to remove from the end
* of this buffer.
*/
def trimEnd(n: Int) { remove(length - n max 0, n) }
/** Send a message to this scriptable object.
*
* @param cmd the message to send.
* !!!! todo: rewrite location, msg etc with enumerations or else pack in a subpackage
def <<(cmd: Message[(Location, A)]) {
cmd match {
case Include((l, elem)) => l match {
case Start => prepend(elem)
case End => append(elem)
case Index(n) => insert(n, elem)
case _ => throw new UnsupportedOperationException("message " + cmd + " not understood")
}
case Update((l, elem)) => l match {
case Start => update(0, elem)
case End => update(length - 1, elem)
case Index(n) => update(n, elem)
case _ => throw new UnsupportedOperationException("message " + cmd + " not understood")
}
case Remove((l, _)) => l match {
case Start => remove(0)
case End => remove(length - 1)
case Index(n) => remove(n)
case _ => throw new UnsupportedOperationException("message " + cmd + " not understood")
}
case Reset() => clear
case s: Script[_] => s.elements foreach <<
case _ => throw new UnsupportedOperationException("message " + cmd + " not understood")
}
}
*/
/** Return a clone of this buffer.
*
* @return a buffer with the same elements.
*/
override def clone(): Buffer[A] = super.clone().asInstanceOf[Buffer[A]]
/** Defines the prefix of the string representation.
*/
override def stringPrefix: String = "Buffer"
/** Adds a number of elements in an array
*
* @param src the array
* @param start the first element to append
* @param len the number of elements to append
* @deprecated replace by: <code>buf ++= src.view(start, end)</code>
*/
@deprecated def ++=(src: Array[A], start: Int, len: Int) {
var i = start
val end = i + len
while (i < end) {
this += src(i)
i += 1
}
}
}
|
