NestingIterator (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

org.neo4j.helpers.collection

## Class NestingIterator<T,U>

- java.lang.Object
- - org.neo4j.helpers.collection.PrefetchingIterator<T>
  - - org.neo4j.helpers.collection.NestingIterator<T,U>

- Type Parameters:
    `T` - the type of items to return
    `U` - the type of items in the surface item iterator
  All Implemented Interfaces:
    Iterator<T>

      public abstract class NestingIterator<T,U>
      extends PrefetchingIterator<T>

  Concatenates sub-iterators of an iterator. Iterates through each item in an iterator. For each item, the `createNestedIterator(Object)` is invoked to create a sub-iterator. The resulting iterator iterates over each item in each sub-iterator. In effect flattening the iteration.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `NestingIterator(Iterator<U> source)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `U` | `getCurrentSurfaceItem()`

    - ### Methods inherited from class org.neo4j.helpers.collection.PrefetchingIterator

      `hasNext, next, peek, remove`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### NestingIterator

          public NestingIterator(Iterator<U> source)

  - ### Method Detail

    - #### getCurrentSurfaceItem

          public U getCurrentSurfaceItem()

Copyright © 2002–2014 The Neo4j Graph Database Project. All rights reserved.