scala.collection.BufferedIterator.scala Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scala-library Show documentation
Show all versions of scala-library Show documentation
Standard library for the Scala Programming Language
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2003-2013, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
package collection
/** Buffered iterators are iterators which provide a method `head`
* that inspects the next element without discarding it.
*
* @author Martin Odersky
* @version 2.8
* @since 2.8
*/
trait BufferedIterator[+A] extends Iterator[A] {
/** Returns next element of iterator without advancing beyond it.
*/
def head: A
/** Returns an option of the next element of an iterator without advancing beyond it.
* @return the next element of this iterator if it has a next element
* `None` if it does not
*/
def headOption : Option[A] = if (hasNext) Some(head) else None
override def buffered: this.type = this
}