iter.Iterator Extends Object
Class/interface for iterators. An iterator needs to implement a {@code next} method and it needs to throw a {@code goog.iter.StopIteration} when the iteration passes beyond the end. Iterators have no {@code hasNext} method. It is recommended to always use the helper functions to iterate over the iterator or in case you are only targeting JavaScript 1.7 for in loops.

Inheritance

Object
     goog.iter.Iterator

Constructor

goog.iter.Iterator()

Instance Methods

Public Protected Private
Defined in goog.iter.Iterator
__iterator__(opt_keys) ⇒
!goog.iter.Iterator
Returns the {@code Iterator} object itself. This is used to implement the iterator protocol in JavaScript 1.7
Arguments:
opt_keys :
boolean
Whether to return the keys or values. Default is to only return the values. This is being used by the for-in loop (true) and the for-each-in loop (false). Even though the param gives a hint about what the iterator will return there is no guarantee that it will return the keys when true is passed.
Returns: 
!goog.iter.Iterator
  The object itself.
code »
next() ⇒
*
Returns the next value of the iteration. This will throw the object {@see goog.iter#StopIteration} when the iteration passes the end.
Returns: 
*
  Any object or value.
code »

Package iter

Package Reference