SI-9691 BufferedIterator should expose a headOption

This exposes a new API to the BufferedIterator trait. It will return the next element of an iterator as an Option.  The return will be  Some(value) if there is a next value, and None if there is not a next element.

1 files changed, 6 insertions, 0 deletions

diff --git a/src/library/scala/collection/BufferedIterator.scala b/src/library/scala/collection/BufferedIterator.scala
index e6e97d584c..1424ef2fd0 100644
--- a/src/library/scala/collection/BufferedIterator.scala
+++ b/src/library/scala/collection/BufferedIterator.scala
@@ -24,5 +24,11 @@ trait BufferedIterator[+A] extends Iterator[A] {
    */
   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
 }