scala

trait Iterable

[source: scala/Iterable.scala]

trait Iterable[+A]
extends AnyRef
Collection classes mixing in this class provide a method elements which returns an iterator over all the elements contained in the collection.
Notes
If a collection has a known size, it should also sub-type Collection. Only potentially unbounded collections should directly sub-class Iterable.
Author
Matthias Zenger
Version
1.1, 04/02/2004
Direct Known Subclasses:
Relation, Collection, Iterable.Projection, IterableProxy, Ranged, Binders.Scope

Method Summary
def ++ [B >: A](that : Iterable[B]) : Collection[B]
Appends two iterable objects.
def /: [B](z : B)(op : (B, A) => B) : B
Similar to foldLeft but can be used as an operator with the order of list and zero arguments reversed. That is, z /: xs is the same as xs foldLeft z
def :\ [B](z : B)(op : (A, B) => B) : B
An alias for foldRight. That is, xs :\ z is the same as xs foldRight z
def addString (buf : StringBuilder, sep : String) : StringBuilder
def addString (buf : StringBuilder, start : String, sep : String, end : String) : StringBuilder
Write all elements of this string into given string builder.
def concat [B >: A](that : Iterable[B]) : Collection[B]
Appends two iterable objects.
def copyToArray [B >: A](xs : Array[B], start : Int) : Unit
Fills the given array xs with the elements of this sequence starting at position start.
def copyToBuffer [B >: A](dest : Buffer[B]) : Unit
Copy all elements to a given buffer
def drop (n : Int) : Collection[A]
Returns this iterable without its n first elements If this iterable has less than n elements, the empty iterable is returned.
def dropWhile (p : (A) => Boolean) : Collection[A]
Returns the longest suffix of this iterable whose first element does not satisfy the predicate p.
abstract def elements : Iterator[A]
Creates a new iterator over all elements contained in this object.
def exists (p : (A) => Boolean) : Boolean
Apply a predicate p to all elements of this iterable object and return true, iff there is at least one element for which p yields true.
def filter (p : (A) => Boolean) : Iterable[A]
Returns all the elements of this iterable that satisfy the predicate p. The order of the elements is preserved.
def find (p : (A) => Boolean) : Option[A]
Find and return the first element of the iterable object satisfying a predicate, if any.
def findIndexOf (p : (A) => Boolean) : Int
Returns index of the first element satisying a predicate, or -1.
def flatMap [B](f : (A) => Iterable[B]) : Iterable[B]
Applies the given function f to each element of this iterable, then concatenates the results.
def foldLeft [B](z : B)(op : (B, A) => B) : B
Combines the elements of this iterable object together using the binary function f, from left to right, and starting with the value z.
def foldRight [B](z : B)(op : (A, B) => B) : B
Combines the elements of this list together using the binary function f, from right to left, and starting with the value z.
def forall (p : (A) => Boolean) : Boolean
Apply a predicate p to all elements of this iterable object and return true, iff the predicate yields true for all elements.
def foreach (f : (A) => Unit) : Unit
Apply a function f to all elements of this iterable object.
def hasDefiniteSize : Boolean
returns true iff this collection has a bound size. Many APIs in this trait will not work on collections of unbound sizes.
def indexOf [B >: A](elem : B) : Int
Returns the index of the first occurence of the specified object in this iterable object.
def isEmpty : Boolean
Is this collection empty?
def map [B](f : (A) => B) : Iterable[B]
Returns the iterable resulting from applying the given function f to each element of this iterable.
def mkString (start : String, sep : String, end : String) : String
Returns a string representation of this iterable object. The resulting string begins with the string start and is finished by the string end. Inside, the string representations of elements (w.r.t. the method toString()) are separated by the string sep.
def mkString : String
Converts a collection into a flat String by each element's toString method.
def mkString (sep : String) : String
Returns a string representation of this iterable object. The string representations of elements (w.r.t. the method toString()) are separated by the string sep.
def projection : Projection[A]
returns a projection that can be used to call non-strict filter, map, and flatMap methods that build projections of the collection.
def reduceLeft [B >: A](op : (B, B) => B) : B
Combines the elements of this iterable object together using the binary operator op, from left to right
def reduceRight [B >: A](op : (B, B) => B) : B
Combines the elements of this iterable object together using the binary operator op, from right to left
def sameElements [B >: A](that : Iterable[B]) : Boolean
Checks if the other iterable object contains the same elements.
def take (n : Int) : Collection[A]
Returns an iterable consisting only over the first n elements of this iterable, or else the whole iterable, if it has less than n elements.
def takeWhile (p : (A) => Boolean) : Iterable[A]
Returns the longest prefix of this iterable whose elements satisfy the predicate p.
def toList : List[A]
Create a fresh list with all the elements of this iterable object.
def toStream : Stream[A]
Create a stream which contains all the elements of this iterable object.
Methods inherited from AnyRef
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf