Scaladoc for scala.xml.pull.ProducerConsumerIterator

Inherited

Hide All
Show all

Iterator
TraversableOnce
AnyRef
Any

Visibility

Public
All

Type Members

class GroupedIterator[B >: A] extends Iterator[Seq[B]]

A flexible iterator for transforming an Iterator[A] into an Iterator[Seq[A]], with configurable sequence size, step, and strategy for dealing with elements which don't fit evenly.

Value Members

def !=(arg0: AnyRef): Boolean

attributes: final
definition classes: AnyRef
def !=(arg0: Any): Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ##(): Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf[T0](): T0

attributes: final
definition classes: AnyRef
def $isInstanceOf[T0](): Boolean

attributes: final
definition classes: AnyRef
def ++(that: ⇒ Iterator[T]): Iterator[T]

[use case] Concatenates this iterator with another.

[use case]
Concatenates this iterator with another.
that
the other iterator
returns
a new iterator that first yields the values produced by this iterator followed by the values produced by iterator that.
attributes: abstract
def ++[B >: T](that: ⇒ Iterator[B]): Iterator[B]

Concatenates this iterator with another.

Concatenates this iterator with another.
that
the other iterator
returns
a new iterator that first yields the values produced by this iterator followed by the values produced by iterator that.
definition classes: Iterator
def /:[B](z: B)(op: (B, T) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left: op(...op(op(z, x₁), x₂), ..., x_n) where x,,1,,, ..., x,,n,, are the elements of this traversable or iterator.
definition classes: TraversableOnce
def :\[B](z: B)(op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value
op
the binary operator
returns
the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right: op(x₁, op(x₂, ... op(x_n, z)...)) where x,,1,,, ..., x,,n,, are the elements of this traversable or iterator.
definition classes: TraversableOnce
def ==(arg0: AnyRef): Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def ==(arg0: Any): Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
val EndOfStream: T

attributes: abstract
val MaxQueueSize: Int
def addString(b: StringBuilder): StringBuilder

Appends all elements of this traversable or iterator to a string builder.

Appends all elements of this traversable or iterator to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable or iterator without any separator string.
b
the string builder to which elements are appended.
returns
the string builder b to which elements were appended.
definition classes: TraversableOnce
def addString(b: StringBuilder, sep: String): StringBuilder

Appends all elements of this traversable or iterator to a string builder using a separator string.

Appends all elements of this traversable or iterator to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable or iterator, separated by the string sep.
b
the string builder to which elements are appended.
sep
the separator string.
returns
the string builder b to which elements were appended.
definition classes: TraversableOnce
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings.

Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.
b
the string builder to which elements are appended.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
the string builder b to which elements were appended.
definition classes: TraversableOnce
def append[B >: T](that: Iterator[B]): Iterator[B]

Returns a new iterator that first yields the elements of this iterator followed by the elements provided by iterator that.
Returns a new iterator that first yields the elements of this iterator followed by the elements provided by iterator that.
definition classes: Iterator
1. use ++
def asInstanceOf[T0]: T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object.
attributes: final
definition classes: Any
def available(): Boolean
def buffered: BufferedIterator[T]

Creates a buffered iterator from this iterator.
Creates a buffered iterator from this iterator.
returns
a buffered iterator producing the same values as this iterator.
definition classes: Iterator
1. BufferedIterator
def clone(): AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
def collect[B](pf: PartialFunction[T, B]): Iterator[B]

Creates an iterator by transforming values produced by this iterator with a partial function, dropping those values for which the partial function is not defined.

Creates an iterator by transforming values produced by this iterator with a partial function, dropping those values for which the partial function is not defined.
pf
the partial function which filters and maps the iterator.
returns
a new iterator which yields each value x produced by this iterator for which pf is defined the image pf(x).
definition classes: Iterator
def contains(elem: Any): Boolean

Tests whether this iterator contains a given value as an element.

Tests whether this iterator contains a given value as an element.
Note: may not terminate for infinite iterators.
elem
the element to test.
returns
true if this iterator produces some value that is is equal (wrt ==) to elem, false otherwise.
definition classes: Iterator
def copyToArray(xs: Array[T], start: Int, len: Int): Unit

[use case] Copies selected values produced by this iterator to an array.

[use case]
Copies selected values produced by this iterator to an array. Fills the given array xs with at most len values produced by this iterator, after skipping start values. Copying will stop once either the end of the current iterator is reached, or the end of the array is reached, or len elements have been copied.
xs
the array to fill.
start
the starting index.
len
the maximal number of elements to copy.
attributes: abstract
def copyToArray[B >: T](xs: Array[B], start: Int, len: Int): Unit

Copies selected values produced by this iterator to an array.

Copies selected values produced by this iterator to an array. Fills the given array xs with at most len values produced by this iterator, after skipping start values. Copying will stop once either the end of the current iterator is reached, or the end of the array is reached, or len elements have been copied.
Note: will not terminate for infinite iterators.
B
the type of the elements of the array.
xs
the array to fill.
start
the starting index.
len
the maximal number of elements to copy.
definition classes: Iterator → TraversableOnce
def copyToArray(xs: Array[T]): Unit

[use case] Copies values of this traversable or iterator to an array.

[use case]
Copies values of this traversable or iterator to an array. Fills the given array xs with values of this traversable or iterator. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the array is reached.
xs
the array to fill.
attributes: abstract
def copyToArray[B >: T](xs: Array[B]): Unit

Copies values of this traversable or iterator to an array.

Copies values of this traversable or iterator to an array. Fills the given array xs with values of this traversable or iterator. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the array is reached.
Note: will not terminate for infinite iterators.
B
the type of the elements of the array.
xs
the array to fill.
definition classes: TraversableOnce
def copyToArray(xs: Array[T], start: Int): Unit

[use case] Copies values of this traversable or iterator to an array.

[use case]
Copies values of this traversable or iterator to an array. Fills the given array xs with values of this traversable or iterator, after skipping start values. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the array is reached.
xs
the array to fill.
start
the starting index.
attributes: abstract
def copyToArray[B >: T](xs: Array[B], start: Int): Unit

Copies values of this traversable or iterator to an array.

Copies values of this traversable or iterator to an array. Fills the given array xs with values of this traversable or iterator, after skipping start values. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the array is reached.
Note: will not terminate for infinite iterators.
B
the type of the elements of the array.
xs
the array to fill.
start
the starting index.
definition classes: TraversableOnce
def copyToBuffer[B >: T](dest: Buffer[B]): Unit

Copies all elements of this traversable or iterator to a buffer.

Copies all elements of this traversable or iterator to a buffer.
Note: will not terminate for infinite iterators.
dest
The buffer to which elements are copied.
definition classes: TraversableOnce
def count(p: (T) ⇒ Boolean): Int

Counts the number of elements in the traversable or iterator which satisfy a predicate.

Counts the number of elements in the traversable or iterator which satisfy a predicate.
p
the predicate used to test elements.
returns
the number of elements satisfying the predicate p.
definition classes: TraversableOnce
def counted: CountedIterator[T]

Returns a counted iterator from this iterator.
Returns a counted iterator from this iterator.
definition classes: Iterator
1. use zipWithIndex in Iterator
def drop(n: Int): Iterator[T]

Advances this iterator past the first n elements, or the length of the iterator, whichever is smaller.

Advances this iterator past the first n elements, or the length of the iterator, whichever is smaller.
n
the number of elements to drop
returns
an iterator which produces all values of the current iterator, except it omits the first n values.
definition classes: Iterator
def dropWhile(p: (T) ⇒ Boolean): Iterator[T]

Skips longest sequence of elements of this iterator which satisfy given predicate p, and returns an iterator of the remaining elements.

Skips longest sequence of elements of this iterator which satisfy given predicate p, and returns an iterator of the remaining elements.
p
the predicate used to skip elements.
returns
an iterator consisting of the remaining elements
definition classes: Iterator
def duplicate: (Iterator[T], Iterator[T])

Creates two new iterators that both iterate over the same elements as this iterator (in the same order).

Creates two new iterators that both iterate over the same elements as this iterator (in the same order). The duplicate iterators are considered equal if they are positioned at the same element.
returns
a pair of iterators
definition classes: Iterator
def eq(arg0: AnyRef): Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals(arg0: Any): Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def exists(p: (T) ⇒ Boolean): Boolean

Tests whether a predicate holds for some of the values produced by this iterator.

Tests whether a predicate holds for some of the values produced by this iterator.
Note: may not terminate for infinite iterators.
p
the predicate used to test elements.
returns
true if the given predicate p holds for some of the values produced by this iterator, otherwise false.
definition classes: Iterator → TraversableOnce
def filter(p: (T) ⇒ Boolean): Iterator[T]

Returns an iterator over all the elements of this iterator that satisfy the predicate p.

Returns an iterator over all the elements of this iterator that satisfy the predicate p. The order of the elements is preserved.
p
the predicate used to test values.
returns
an iterator which produces those values of this iterator which satisfy the predicate p.
definition classes: Iterator
def filterNot(p: (T) ⇒ Boolean): Iterator[T]

Creates an iterator over all the elements of this iterator which do not satisfy a predicate p.

Creates an iterator over all the elements of this iterator which do not satisfy a predicate p.
p
the predicate used to test values.
returns
an iterator which produces those values of this iterator which do not satisfy the predicate p.
definition classes: Iterator
def finalize(): Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def find(p: (T) ⇒ Boolean): Option[T]

Finds the first value produced by the iterator satisfying a predicate, if any.

Finds the first value produced by the iterator satisfying a predicate, if any.
Note: may not terminate for infinite iterators.
p
the predicate used to test values.
returns
an option value containing the first value produced by the iterator that satisfies predicate p, or None if none exists.
definition classes: Iterator → TraversableOnce
def findIndexOf(p: (T) ⇒ Boolean): Int

Returns index of the first element satisfying a predicate, or -1.
Returns index of the first element satisfying a predicate, or -1.
definition classes: Iterator
1. use indexWhere instead
def flatMap[B](f: (T) ⇒ Iterator[B]): Iterator[B]

Creates a new iterator by applying a function to all values produced by this iterator and concatenating the results.

Creates a new iterator by applying a function to all values produced by this iterator and concatenating the results.
f
the function to apply on each element.
returns
the iterator resulting from applying the given iterator-valued function f to each value produced by this iterator and concatenating the results.
definition classes: Iterator
def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left: op(...op(z, x₁), x₂, ..., x_n) where x,,1,,, ..., x,,n,, are the elements of this traversable or iterator.
definition classes: TraversableOnce
def foldRight[B](z: B)(op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right: op(x₁, op(x₂, ... op(x_n, z)...)) where x,,1,,, ..., x,,n,, are the elements of this traversable or iterator.
definition classes: TraversableOnce
def forall(p: (T) ⇒ Boolean): Boolean

Tests whether a predicate holds for all values produced by this iterator.

Tests whether a predicate holds for all values produced by this iterator.
Note: may not terminate for infinite iterators.
p
the predicate used to test elements.
returns
true if the given predicate p holds for all values produced by this iterator, otherwise false.
definition classes: Iterator → TraversableOnce
def foreach(f: (T) ⇒ Unit): Unit

[use case] Applies a function f to all values produced by this iterator.

[use case]
Applies a function f to all values produced by this iterator.
f
the function that is applied for its side-effect to every element. The result of function f is discarded.
attributes: abstract
def foreach[U](f: (T) ⇒ U): Unit

Applies a function f to all values produced by this iterator.

Applies a function f to all values produced by this iterator.
U
the type parameter describing the result of function f. This result will always be ignored. Typically U is Unit, but this is not necessary.
f
the function that is applied for its side-effect to every element. The result of function f is discarded.
definition classes: Iterator → TraversableOnce
def getClass(): java.lang.Class[_ <: java.lang.Object]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef

def grouped[B >: T](size: Int): GroupedIterator[B]

Returns an iterator which groups this iterator into fixed size blocks.

def hasDefiniteSize: Boolean

Tests whether this Iterator has a known size.

Tests whether this Iterator has a known size.
returns
true for empty Iterators, false otherwise.
definition classes: Iterator → TraversableOnce
def hasNext(): Boolean

Tests whether this iterator can provide another element.

Tests whether this iterator can provide another element.
returns
true if a subsequent call to next will yield an element, false otherwise.
definition classes: ProducerConsumerIterator → Iterator
def hashCode(): Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
def indexOf[B >: T](elem: B): Int

Returns the index of the first occurrence of the specified object in this iterable object.

Returns the index of the first occurrence of the specified object in this iterable object.
Note: may not terminate for infinite iterators.
elem
element to search for.
returns
the index of the first occurrence of elem in the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.
definition classes: Iterator
def indexWhere(p: (T) ⇒ Boolean): Int

Returns the index of the first produced value satisfying a predicate, or -1.

Returns the index of the first produced value satisfying a predicate, or -1.
Note: may not terminate for infinite iterators.
p
the predicate to test values
returns
the index of the first produced value satisfying p, or -1 if such an element does not exist until the end of the iterator is reached.
definition classes: Iterator
def interruptibly[T](body: ⇒ T): Option[T]
def isEmpty: Boolean

Tests whether this iterator is empty.

Tests whether this iterator is empty.
returns
true if hasNext is false, false otherwise.
definition classes: Iterator → TraversableOnce
def isInstanceOf[T0]: Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def isTraversableAgain: Boolean

Tests whether this Iterator can be repeatedly traversed.

Tests whether this Iterator can be repeatedly traversed.
returns
false
definition classes: Iterator → TraversableOnce
def length: Int

Returns the number of elements in this iterator.

Returns the number of elements in this iterator.
Note: will not terminate for infinite iterators.
Note: The iterator is at its end after this method returns.
definition classes: Iterator
def map[B](f: (T) ⇒ B): Iterator[B]

Creates a new iterator that maps all produced values of this iterator to new values using a transformation function.

Creates a new iterator that maps all produced values of this iterator to new values using a transformation function.
f
the transformation function
returns
a new iterator which transforms every value produced by this iterator by applying the function f to it.
definition classes: Iterator
def max: T

[use case] Finds the largest element.

[use case]
Finds the largest element.
returns
the largest element of this traversable or iterator.
attributes: abstract
def max[B >: T](implicit cmp: Ordering[B]): T

Finds the largest element.

Finds the largest element.
B
The type over which the ordering is defined.
cmp
An ordering to be used for comparing elements.
returns
the largest element of this traversable or iterator with respect to the ordering cmp.
definition classes: TraversableOnce
def min: T

[use case] Finds the smallest element.

[use case]
Finds the smallest element.
returns
the smallest element of this traversable or iterator
attributes: abstract
def min[B >: T](implicit cmp: Ordering[B]): T

Finds the smallest element.

Finds the smallest element.
B
The type over which the ordering is defined.
cmp
An ordering to be used for comparing elements.
returns
the smallest element of this traversable or iterator with respect to the ordering cmp.
definition classes: TraversableOnce
def mkString: String

Displays all elements of this traversable or iterator in a string.

Displays all elements of this traversable or iterator in a string.
returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString) of all elements of this traversable or iterator follow each other without any separator string.
definition classes: TraversableOnce
def mkString(sep: String): String

Displays all elements of this traversable or iterator in a string using a separator string.

Displays all elements of this traversable or iterator in a string using a separator string.
sep
the separator string.
returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.
definition classes: TraversableOnce
def mkString(start: String, sep: String, end: String): String

Displays all elements of this traversable or iterator in a string using start, end, and separator strings.

Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
a string representation of this traversable or iterator. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.
definition classes: TraversableOnce
def ne(arg0: AnyRef): Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def next(): T

Produces the next element of this iterator.

Produces the next element of this iterator.
returns
the next element of this iterator, if hasNext is true, undefined behavior otherwise.
definition classes: ProducerConsumerIterator → Iterator
def nonEmpty: Boolean

Tests whether the traversable or iterator is not empty.

Tests whether the traversable or iterator is not empty.
returns
true if the traversable or iterator contains at least one element, false otherwise.
definition classes: TraversableOnce
def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def padTo(len: Int, elem: T): Iterator[T]

[use case] Appends an element value to this iterator until a given target length is reached.

[use case]
Appends an element value to this iterator until a given target length is reached.
len
the target length
elem
the padding value
returns
a new iterator consisting of producing all values of this iterator, followed by the minimal number of occurrences of elem so that the number of produced values is at least len.
attributes: abstract
def padTo[A1 >: T](len: Int, elem: A1): Iterator[A1]

Appends an element value to this iterator until a given target length is reached.

Appends an element value to this iterator until a given target length is reached.
len
the target length
elem
the padding value
returns
a new iterator consisting of producing all values of this iterator, followed by the minimal number of occurrences of elem so that the number of produced values is at least len.
definition classes: Iterator
def partition(p: (T) ⇒ Boolean): (Iterator[T], Iterator[T])

Partitions this iterator in two iterators according to a predicate.

Partitions this iterator in two iterators according to a predicate.
p
the predicate on which to partition
returns
a pair of iterators: the iterator that satisfies the predicate p and the iterator that does not. The relative order of the elements in the resulting iterators is the same as in the original iterator.
definition classes: Iterator
def patch[B >: T](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]

Returns this iterator with patched values.

Returns this iterator with patched values.
from
The start index from which to patch
replaced
The number of values in the original iterator that are replaced by the patch.
definition classes: Iterator
def produce(x: T): Unit
def product: Int

[use case] Multiplies up the elements of this collection.

[use case]
Multiplies up the elements of this collection.
returns
the product of all elements in this traversable or iterator of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the traversable or iterator and as result type of product. Examples of such types are: Long, Float, Double, BigInt.
attributes: abstract
def product[B >: T](implicit num: Numeric[B]): B

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.
B
the result type of the * operator.
num
an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.
returns
the product of all elements of this traversable or iterator with respect to the * operator in num.
definition classes: TraversableOnce
def readInto[B >: T](xs: Array[B]): Unit
definition classes: Iterator
1. use copyToArray instead
def readInto[B >: T](xs: Array[B], start: Int): Unit
definition classes: Iterator
1. use copyToArray instead
def readInto[B >: T](xs: Array[B], start: Int, sz: Int): Unit

Fills the given array xs with the elements of this sequence starting at position start.
Fills the given array xs with the elements of this sequence starting at position start. Like copyToArray, but designed to accomodate IO stream operations.
Note: the array must be large enough to hold sz elements.
xs
the array to fill.
start
the starting index.
sz
the maximum number of elements to be read.
definition classes: Iterator
1. use copyToArray instead
def reduceLeft[B >: T](op: (B, T) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator, going left to right.
Applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going left to right: op(...(op(x₁, x₂), ... ) , x_n) where x,,1,,, ..., x,,n,, are the elements of this traversable or iterator.
definition classes: TraversableOnce
def reduceLeftOption[B >: T](op: (B, T) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceLeft(op) is this traversable or iterator is nonempty, None otherwise.
definition classes: TraversableOnce
def reduceRight[B >: T](op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator, going right to left.
Applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going right to left: op(x₁, op(x₂, ..., op(x_n-1, x_n)...)) where x,,1,,, ..., x,,n,, are the elements of this traversable or iterator.
definition classes: TraversableOnce
def reduceRightOption[B >: T](op: (T, B) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceRight(op) is this traversable or iterator is nonempty, None otherwise.
definition classes: TraversableOnce
def reversed: List[T]

attributes: protected[this]
definition classes: TraversableOnce
def sameElements(that: Iterator[_]): Boolean

Tests if another iterator produces the same values as this one.

Tests if another iterator produces the same values as this one.
Note: will not terminate for infinite iterators.
that
the other iterator
returns
true, if both iterators produce the same elements in the same order, false otherwise.
definition classes: Iterator
def size: Int

The size of this traversable or iterator.

The size of this traversable or iterator.
Note: will not terminate for infinite iterators.
returns
the number of elements in this traversable or iterator.
definition classes: TraversableOnce
def slice(from: Int, until: Int): Iterator[T]

Creates an iterator returning an interval of the values produced by this iterator.

Creates an iterator returning an interval of the values produced by this iterator.
from
the index of the first element in this iterator which forms part of the slice.
until
the index of the first element following the slice.
returns
an iterator which advances this iterator past the first from elements using drop, and then takes until - from elements, using take.
definition classes: Iterator

def sliding[B >: T](size: Int, step: Int = 1): GroupedIterator[B]

Returns an iterator which presents a "sliding window" view of another iterator.

def sum: Int

[use case] Sums up the elements of this collection.

[use case]
Sums up the elements of this collection.
returns
the sum of all elements in this traversable or iterator of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the traversable or iterator and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.
attributes: abstract
def sum[B >: T](implicit num: Numeric[B]): B

Sums up the elements of this collection.

Sums up the elements of this collection.
B
the result type of the + operator.
num
an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.
returns
the sum of all elements of this traversable or iterator with respect to the + operator in num.
definition classes: TraversableOnce
def synchronized[T0](arg0: T0): T0

attributes: final
definition classes: AnyRef
def take(n: Int): Iterator[T]

Selects first n values of this iterator.

Selects first n values of this iterator.
n
the number of values to take
returns
an iterator producing only of the first n values of this iterator, or else the whole iterator, if it produces less than n values.
definition classes: Iterator
def takeWhile(p: (T) ⇒ Boolean): Iterator[T]

Takes longest prefix of values produced by this iterator that satisfy a predicate.

Takes longest prefix of values produced by this iterator that satisfy a predicate.
p
The predicate used to test elements.
returns
An iterator returning the values produced by this iterator, until this iterator produces a value that does not satisfy the predicate p.
definition classes: Iterator
def toArray: Array[T]

[use case] Converts this traversable or iterator to an array.

[use case]
Converts this traversable or iterator to an array.
Note: will not terminate for infinite iterators.
returns
an array containing all elements of this traversable or iterator. A ClassManifest must be available for the element type of this traversable or iterator.
attributes: abstract
def toArray[B >: T](implicit arg0: ClassManifest[B]): Array[B]

Converts this traversable or iterator to an array.

Converts this traversable or iterator to an array.
Note: will not terminate for infinite iterators.
B
the type of the elements of the array. A ClassManifest for this type must be available.
returns
an array containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toBuffer[B >: T]: Buffer[B]

Converts this traversable or iterator to a mutable buffer.

Converts this traversable or iterator to a mutable buffer.
Note: will not terminate for infinite iterators.
returns
a buffer containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toIndexedSeq[B >: T]: IndexedSeq[B]

Converts this traversable or iterator to an indexed sequence.

Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite iterators.
returns
an indexed sequence containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toIterable: Iterable[T]

Converts this traversable or iterator to an iterable collection.

Converts this traversable or iterator to an iterable collection. Note that the choice of target Iterable must be lazy as this TraversableOnce may be lazy and unevaluated.
Note: will not terminate for infinite iterators.
returns
an Iterable containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toIterator: Iterator[T]

Returns an Iterator over the elements in this traversable or iterator.

Returns an Iterator over the elements in this traversable or iterator. Will return the same Iterator if this instance is already an Iterator.
Note: will not terminate for infinite iterators.
returns
an Iterator containing all elements of this traversable or iterator.
definition classes: Iterator → TraversableOnce
def toList: List[T]

Converts this traversable or iterator to a list.

Converts this traversable or iterator to a list.
Note: will not terminate for infinite iterators.
returns
a list containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toMap[T, U](implicit ev: <:<[T, (T, U)]): Map[T, U]

Converts this traversable or iterator to a map.

Converts this traversable or iterator to a map. This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
Note: will not terminate for infinite iterators.
returns
a map containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toSeq: Seq[T]

Converts this traversable or iterator to a sequence.

Converts this traversable or iterator to a sequence. As with toIterable, it must be lazy.
Note: will not terminate for infinite iterators.
returns
a sequence containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toSet[B >: T]: Set[B]

Converts this traversable or iterator to a set.

Converts this traversable or iterator to a set.
Note: will not terminate for infinite iterators.
returns
a set containing all elements of this traversable or iterator.
definition classes: TraversableOnce
def toStream: Stream[T]

Converts this traversable or iterator to a stream.

Converts this traversable or iterator to a stream.
Note: will not terminate for infinite iterators.
returns
a stream containing all elements of this traversable or iterator.
definition classes: Iterator → TraversableOnce
def toString(): String

Converts this iterator to a string.

Converts this iterator to a string.
returns
"empty iterator" or "non-empty iterator", depending on whether or not the iterator is empty.
definition classes: Iterator → AnyRef → Any
def toTraversable: Traversable[T]

Converts this traversable or iterator to an unspecified Traversable.

Converts this traversable or iterator to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite iterators.
returns
a Traversable containing all elements of this traversable or iterator.
definition classes: Iterator → TraversableOnce
def wait(): Unit

attributes: final
definition classes: AnyRef
def wait(arg0: Long, arg1: Int): Unit

attributes: final
definition classes: AnyRef
def wait(arg0: Long): Unit

attributes: final
definition classes: AnyRef
def withFilter(p: (T) ⇒ Boolean): Iterator[T]

Creates an iterator over all the elements of this iterator that satisfy the predicate p.

Creates an iterator over all the elements of this iterator that satisfy the predicate p. The order of the elements is preserved.
Note: withFilter is the same as filter on iterators. It exists so that for-expressions with filters work over iterators.
p
the predicate used to test values.
returns
an iterator which produces those values of this iterator which satisfy the predicate p.
definition classes: Iterator
def zip[B](that: Iterator[B]): Iterator[(T, B)]

Creates an iterator formed from this iterator and another iterator by combining corresponding values in pairs.

Creates an iterator formed from this iterator and another iterator by combining corresponding values in pairs. If one of the two iterators is longer than the other, its remaining elements are ignored.
that
The iterator providing the second half of each result pair
returns
a new iterator containing pairs consisting of corresponding elements of this iterator and that. The number of elements returned by the new iterator is the minimum of the number of elements returned by this iterator and that.
definition classes: Iterator
def zipAll[B](that: Iterator[B], thisElem: T, thatElem: B): Iterator[(T, B)]

[use case] Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs.

[use case]
Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs. If one of the two iterators is shorter than the other, placeholder elements are used to extend the shorter iterator to the length of the longer.
that
iterator that may have a different length as the self iterator.
thisElem
element thisElem is used to fill up the resulting iterator if the self iterator is shorter than that
thatElem
element thatElem is used to fill up the resulting iterator if that is shorter than the self iterator
returns
a new iterator containing pairs consisting of corresponding values of this iterator and that. The length of the returned iterator is the maximum of the lengths of this iterator and that. If this iterator is shorter than that, thisElem values are used to pad the result. If that is shorter than this iterator, thatElem values are used to pad the result.
attributes: abstract
def zipAll[B, A1 >: T, B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]

Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs.

Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs. If one of the two iterators is shorter than the other, placeholder elements are used to extend the shorter iterator to the length of the longer.
that
iterator that may have a different length as the self iterator.
thisElem
element thisElem is used to fill up the resulting iterator if the self iterator is shorter than that
thatElem
element thatElem is used to fill up the resulting iterator if that is shorter than the self iterator
returns
a new iterator containing pairs consisting of corresponding values of this iterator and that. The length of the returned iterator is the maximum of the lengths of this iterator and that. If this iterator is shorter than that, thisElem values are used to pad the result. If that is shorter than this iterator, thatElem values are used to pad the result.
definition classes: Iterator
def zipWithIndex: Iterator[(T, Int)] {...}

Creates an iterator that pairs each element produced by this iterator with its index, counting from 0.

Creates an iterator that pairs each element produced by this iterator with its index, counting from 0.
definition classes: Iterator

ProducerConsumerIterator

trait ProducerConsumerIterator[T >: Null] extends Iterator[T]

Type Members

class GroupedIterator[B >: A] extends Iterator[Seq[B]]

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def ++(that: ⇒ Iterator[T]): Iterator[T]

def ++[B >: T](that: ⇒ Iterator[B]): Iterator[B]

def /:[B](z: B)(op: (B, T) ⇒ B): B

def :\[B](z: B)(op: (T, B) ⇒ B): B

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

val EndOfStream: T

val MaxQueueSize: Int

def addString(b: StringBuilder): StringBuilder

def addString(b: StringBuilder, sep: String): StringBuilder

def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

def append[B >: T](that: Iterator[B]): Iterator[B]

def asInstanceOf[T0]: T0

def available(): Boolean

def buffered: BufferedIterator[T]

def clone(): AnyRef

def collect[B](pf: PartialFunction[T, B]): Iterator[B]

def contains(elem: Any): Boolean

def copyToArray(xs: Array[T], start: Int, len: Int): Unit

def copyToArray[B >: T](xs: Array[B], start: Int, len: Int): Unit

def copyToArray(xs: Array[T]): Unit

def copyToArray[B >: T](xs: Array[B]): Unit

def copyToArray(xs: Array[T], start: Int): Unit

def copyToArray[B >: T](xs: Array[B], start: Int): Unit

def copyToBuffer[B >: T](dest: Buffer[B]): Unit

def count(p: (T) ⇒ Boolean): Int

def counted: CountedIterator[T]

def drop(n: Int): Iterator[T]

def dropWhile(p: (T) ⇒ Boolean): Iterator[T]

def duplicate: (Iterator[T], Iterator[T])

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(p: (T) ⇒ Boolean): Boolean

def filter(p: (T) ⇒ Boolean): Iterator[T]

def filterNot(p: (T) ⇒ Boolean): Iterator[T]

def finalize(): Unit

def find(p: (T) ⇒ Boolean): Option[T]

def findIndexOf(p: (T) ⇒ Boolean): Int

def flatMap[B](f: (T) ⇒ Iterator[B]): Iterator[B]

def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

def foldRight[B](z: B)(op: (T, B) ⇒ B): B

def forall(p: (T) ⇒ Boolean): Boolean

def foreach(f: (T) ⇒ Unit): Unit

def foreach[U](f: (T) ⇒ U): Unit

def getClass(): java.lang.Class[_ <: java.lang.Object]

def grouped[B >: T](size: Int): GroupedIterator[B]

def hasDefiniteSize: Boolean

def hasNext(): Boolean

def hashCode(): Int

def indexOf[B >: T](elem: B): Int

def indexWhere(p: (T) ⇒ Boolean): Int

def interruptibly[T](body: ⇒ T): Option[T]

def isEmpty: Boolean

def isInstanceOf[T0]: Boolean

def isTraversableAgain: Boolean

def length: Int

def map[B](f: (T) ⇒ B): Iterator[B]

def max: T

def max[B >: T](implicit cmp: Ordering[B]): T

def min: T

def min[B >: T](implicit cmp: Ordering[B]): T

def mkString: String

def mkString(sep: String): String

def mkString(start: String, sep: String, end: String): String

def ne(arg0: AnyRef): Boolean

def next(): T

def nonEmpty: Boolean

def notify(): Unit

def notifyAll(): Unit

def padTo(len: Int, elem: T): Iterator[T]