org.neo4j.helpers.collection (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

# Package org.neo4j.helpers.collection

Collections utilities - Iterator/Iterable utilities and creating `Map`s.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  ClosableIterable<T> |
  ClosableIterator<T> |
  Visitable<T> |
  Visitor<E,FAILURE extends Exception> | A visitor to internalize iteration.

- Class Summary
  Class | Description
  --- | ---
  ArrayIterator<T> |
  CachingIterator<T> | An `Iterator` which lazily fetches and caches items from the underlying iterator when items are requested.
  CatchingIteratorWrapper<T,U> |
  CollectionWrapper<T,U> | Wraps a `Collection`, making it look (and function) like a collection holding another type of items.
  CombiningIterable<T> | Combining one or more `Iterable`s, making them look like they were one big iterable.
  CombiningIterator<T> | Combining one or more `Iterator`s, making them look like they were one big iterator.
  CombiningResourceIterator<T> |
  ExceptionHandlingIterable<T> | allows to catch, analyze and react on exceptions that are thrown by the delegate iterable useful for exception conversion on iterator methods Uses sun.misc.Unsafe internally to rethrow original exceptions !
  FilteringIterable<T> | An iterable which filters another iterable, only letting items with certain criterias pass through.
  FilteringIterator<T> | An iterator which filters another iterator, only letting items with certain criterias pass through.
  FirstItemIterable<T> | Wraps the given iterator but keeps the first item to allow later access to it, like CachingIterator but with less memory overhead.
  Iterables | TODO: Combine this and `IteratorUtil` into one class
  IterableWrapper<T,U> | Wraps an `Iterable` so that it returns items of another type.
  IteratorUtil | Contains common functionality regarding `Iterator`s and `Iterable`s.
  IteratorWrapper<T,U> | Wraps an `Iterator` so that it returns items of another type.
  LimitingIterable<T> | Limits the amount of items returned by an `Iterable`, or rather `Iterator`s spawned from it.
  LimitingIterator<T> | Limits the amount of items returned by an `Iterator`.
  LinesOfFileIterator |
  LruMap<K,V> |
  MapUtil | Utility to create `Map`s.
  NestingIterable<T,U> | Concatenates sub-iterables of an iterable.
  NestingIterator<T,U> | Concatenates sub-iterators of an iterator.
  PagingIterator<T> | A `CachingIterator` which can more easily divide the items into pages, where optionally each page can be seen as its own `Iterator` instance for convenience using `PagingIterator.nextPage()`.
  PositionedIterator<T> | Decorator class that wraps any iterator and remembers the current node.
  PrefetchingIterator<T> | Abstract class for how you usually implement iterators when you don't know how many objects there are (which is pretty much every time) Basically the `PrefetchingIterator.hasNext()` method will look up the next object and cache it.
  PrefetchingResourceIterator<T> |
  RangeIterator | Iterates over a range, where the start value is inclusive, but the end value is exclusive.
  ResourceClosingIterator<T,V> |
  ReverseArrayIterator<T> |
  Visitor.SafeGenerics |

## Package org.neo4j.helpers.collection Description

Collections utilities - Iterator/Iterable utilities and creating `Map`s.

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