Iterables (Neo4j 3.4.0-alpha06 API)

java.lang.Object
- org.neo4j.helpers.collection.Iterables

public final class Iterables
extends Object

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T,C extends Collection<T>> C`	`addAll(C collection, Iterable<? extends T> iterable)`
`static <C extends Collection<T>,T> C`	`addToCollection(Iterable<T> iterable, C collection)` Adds all the items in `iterator` to `collection`.
`static <T,C extends T> Iterable<T>`	`append(C item, Iterable<T> iterable)`
`static <T> T[]`	`asArray(Class<T> componentType, Iterable<T> iterable)`
`static Object[]`	`asArray(Iterable<Object> iterable)`
`static <T> Collection<T>`	`asCollection(Iterable<T> iterable)` Creates a collection from an iterable.
`static Iterable<Integer>`	`asIterable(int... array)`
`static Iterable<Long>`	`asIterable(long... array)`
`static <T> Iterable<T>`	`asIterable(T... array)`
`static <T> List<T>`	`asList(Iterable<T> iterator)`
`static <T,U> Map<T,U>`	`asMap(Iterable<Pair<T,U>> pairs)`
`static <T> org.neo4j.graphdb.ResourceIterable<T>`	`asResourceIterable(Iterable<T> iterable)`
`static <T> Set<T>`	`asSet(Iterable<T> iterable)` Creates a `Set` from an `Iterable`.
`static <T> Set<T>`	`asUniqueSet(Iterable<T> iterable)` Creates a `Set` from an `Iterable`.
`static <T> Iterable<T>`	`cache(Iterable<T> iterable)`
`static <T,C> Iterable<T>`	`cast(Iterable<C> iterable)`
`static <T> Iterable<T>`	`concat(Iterable<? extends T>... iterables)`
`static <T> Iterable<T>`	`concat(Iterable<Iterable<T>> iterables)`
`static <T> long`	`count(Iterable<T> iterable)` Counts the number of items in the `iterator` by looping through it.
`static <T> long`	`count(Iterable<T> iterable, Predicate<T> filter)` Counts the number of filtered items in the `iterable` by looping through it.
`static <T> Iterable<T>`	`empty()`
`static <T> Iterable<T>`	`emptyResourceIterable()`
`static <T extends Enum<T>> List<String>`	`enumNames(Class<T> cls)`
`static <X> Iterable<X>`	`filter(Predicate<? super X> specification, Iterable<X> i)`
`static <T> T`	`first(Iterable<T> iterable)` Returns the given iterable's first element.
`static <T> T`	`firstOrNull(Iterable<T> iterable)` Returns the given iterable's first element or `null` if no element found.
`static <FROM,TO> Iterable<TO>`	`flatMap(Function<? super FROM,? extends Iterable<TO>> function, Iterable<FROM> from)`
`static <X,I extends Iterable<? extends X>> Iterable<X>`	`flatten(I... multiIterator)`
`static <X,S extends Iterable<? extends X>,I extends Iterable<S>> Iterable<X>`	`flattenIterable(I multiIterator)`
`static <T> T`	`fromEnd(Iterable<T> iterable, int n)` Returns the iterator's n:th item from the end of the iteration.
`static <T> int`	`indexOf(T itemToFind, Iterable<T> iterable)` Returns the index of the first occurrence of the specified element in this iterable, or -1 if this iterable does not contain the element.
`static <T,C extends T> Iterable<T>`	`iterable(C... items)`
`static String`	`join(String joinString, Iterable<?> iter)`
`static <T> T`	`last(Iterable<T> iterable)` Returns the given iterable's last element.
`static <T> T`	`lastOrNull(Iterable<T> iterable)` Returns the given iterable's last element or `null` if no element found.
`static <T> Function<Iterable<T>,Iterable<T>>`	`limit(int limitItems)`
`static <T> Iterable<T>`	`limit(int limitItems, Iterable<T> iterable)`
`static <FROM,TO> Iterable<TO>`	`map(Function<? super FROM,? extends TO> function, Iterable<FROM> from)`
`static <T> Iterable<T>`	`mix(Iterable<T>... iterables)`
`static <T> Iterable<T>`	`option(T item)`
`static <T,C extends T> Iterable<T>`	`prepend(C item, Iterable<T> iterable)`
`static <T> org.neo4j.graphdb.ResourceIterable<T>`	`resourceIterable(Iterable<T> iterable)`
`static <X> Iterable<X>`	`reverse(Iterable<X> iterable)`
`static <T> T`	`single(Iterable<T> iterable)` Returns the given iterable's single element.
`static <T> T`	`single(Iterable<T> iterable, T itemIfNone)` Returns the given iterable's single element or `itemIfNone` if no element found.
`static <T> T`	`singleOrNull(Iterable<T> iterable)` Returns the given iterable's single element or `null` if no element found.
`static <X> Iterable<X>`	`skip(int skip, Iterable<X> iterable)`
`static <T,S extends Comparable> Iterable<T>`	`sort(Iterable<T> iterable, Function<T,S> compareFunction)`
`static <T> Stream<T>`	`stream(Iterable<T> iterable)` Create a stream from the given iterable.
`static <T> Stream<T>`	`stream(Iterable<T> iterable, int characteristics)` Create a stream from the given iterable with given characteristics.
`static String`	`toString(Iterable<?> values, String separator)`
`static <T> Iterable<T>`	`unique(Iterable<T> iterable)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - empty
```
public static <T> Iterable<T> empty()
```
  - emptyResourceIterable
```
public static <T> Iterable<T> emptyResourceIterable()
```
  - limit
```
public static <T> Iterable<T> limit(int limitItems,
                                    Iterable<T> iterable)
```
  - limit
```
public static <T> Function<Iterable<T>,Iterable<T>> limit(int limitItems)
```
  - unique
```
public static <T> Iterable<T> unique(Iterable<T> iterable)
```
  - addAll
```
public static <T,C extends Collection<T>> C addAll(C collection,
                                                   Iterable<? extends T> iterable)
```
  - filter
```
public static <X> Iterable<X> filter(Predicate<? super X> specification,
                                     Iterable<X> i)
```
  - skip
```
public static <X> Iterable<X> skip(int skip,
                                   Iterable<X> iterable)
```
  - reverse
```
public static <X> Iterable<X> reverse(Iterable<X> iterable)
```
  - flatten
```
@SafeVarargs
public static <X,I extends Iterable<? extends X>> Iterable<X> flatten(I... multiIterator)
```
  - flattenIterable
```
public static <X,S extends Iterable<? extends X>,I extends Iterable<S>> Iterable<X> flattenIterable(I multiIterator)
```
  - mix
```
@SafeVarargs
public static <T> Iterable<T> mix(Iterable<T>... iterables)
```
  - map
```
public static <FROM,TO> Iterable<TO> map(Function<? super FROM,? extends TO> function,
                                         Iterable<FROM> from)
```
  - flatMap
```
public static <FROM,TO> Iterable<TO> flatMap(Function<? super FROM,? extends Iterable<TO>> function,
                                             Iterable<FROM> from)
```
  - iterable
```
@SafeVarargs
public static <T,C extends T> Iterable<T> iterable(C... items)
```
  - cast
```
public static <T,C> Iterable<T> cast(Iterable<C> iterable)
```
  - concat
```
@SafeVarargs
public static <T> Iterable<T> concat(Iterable<? extends T>... iterables)
```
  - concat
```
public static <T> Iterable<T> concat(Iterable<Iterable<T>> iterables)
```
  - prepend
```
public static <T,C extends T> Iterable<T> prepend(C item,
                                                  Iterable<T> iterable)
```
  - append
```
public static <T,C extends T> Iterable<T> append(C item,
                                                 Iterable<T> iterable)
```
  - cache
```
public static <T> Iterable<T> cache(Iterable<T> iterable)
```
  - asArray
```
public static Object[] asArray(Iterable<Object> iterable)
```
  - asArray
```
public static <T> T[] asArray(Class<T> componentType,
                              Iterable<T> iterable)
```
  - asResourceIterable
```
public static <T> org.neo4j.graphdb.ResourceIterable<T> asResourceIterable(Iterable<T> iterable)
```
  - toString
```
public static String toString(Iterable<?> values,
                              String separator)
```
  - firstOrNull
```
public static <T> T firstOrNull(Iterable<T> iterable)
```
    Returns the given iterable's first element or null if no element found. If the iterator created by the iterable implements Resource it will be closed in a finally block after the single item has been retrieved, or failed to be retrieved.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    Returns:
    
    the first element in the iterable, or null if no element found.
  - first
```
public static <T> T first(Iterable<T> iterable)
```
    Returns the given iterable's first element. If no element is found a NoSuchElementException is thrown.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    Returns:
    
    the first element in the iterable.
    
    Throws:
    
    NoSuchElementException - if no element found.
  - lastOrNull
```
public static <T> T lastOrNull(Iterable<T> iterable)
```
    Returns the given iterable's last element or null if no element found.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    Returns:
    
    the last element in the iterable, or null if no element found.
  - last
```
public static <T> T last(Iterable<T> iterable)
```
    Returns the given iterable's last element. If no element is found a NoSuchElementException is thrown.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    Returns:
    
    the last element in the iterable.
    
    Throws:
    
    NoSuchElementException - if no element found.
  - singleOrNull
```
public static <T> T singleOrNull(Iterable<T> iterable)
```
    Returns the given iterable's single element or null if no element found. If there is more than one element in the iterable a NoSuchElementException will be thrown. If the iterator created by the iterable implements Resource it will be closed in a finally block after the single item has been retrieved, or failed to be retrieved.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    Returns:
    
    the single element in iterable, or null if no element found.
    
    Throws:
    
    NoSuchElementException - if more than one element was found.
  - single
```
public static <T> T single(Iterable<T> iterable)
```
    Returns the given iterable's single element. If there are no elements or more than one element in the iterable a NoSuchElementException will be thrown. If the iterator created by the iterable implements Resource it will be closed in a finally block after the single item has been retrieved, or failed to be retrieved.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    Returns:
    
    the single element in the iterable.
    
    Throws:
    
    NoSuchElementException - if there isn't exactly one element.
  - single
```
public static <T> T single(Iterable<T> iterable,
                           T itemIfNone)
```
    Returns the given iterable's single element or itemIfNone if no element found. If there is more than one element in the iterable a NoSuchElementException will be thrown. If the iterator created by the iterable implements Resource it will be closed in a finally block after the single item has been retrieved, or failed to be retrieved.
    
    Type Parameters:
    
    T - the type of elements in iterable.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    itemIfNone - item to use if none is found
    
    Returns:
    
    the single element in iterable, or null if no element found.
    
    Throws:
    
    NoSuchElementException - if more than one element was found.
  - fromEnd
```
public static <T> T fromEnd(Iterable<T> iterable,
                            int n)
```
    Returns the iterator's n:th item from the end of the iteration. If the iterator has got less than n-1 items in it NoSuchElementException is thrown.
    
    Type Parameters:
    
    T - the type of elements in iterator.
    
    Parameters:
    
    iterable - the Iterable to get elements from.
    
    n - the n:th item from the end to get.
    
    Returns:
    
    the iterator's n:th item from the end of the iteration.
    
    Throws:
    
    NoSuchElementException - if the iterator contains less than n-1 items.
  - addToCollection
```
public static <C extends Collection<T>,T> C addToCollection(Iterable<T> iterable,
                                                            C collection)
```
    Adds all the items in iterator to collection.
    
    Type Parameters:
    
    C - the type of Collection to add to items to.
    
    T - the type of items in the collection and iterator.
    
    Parameters:
    
    iterable - the Iterator to grab the items from.
    
    collection - the Collection to add the items to.
    
    Returns:
    
    the collection which was passed in, now filled with the items from iterator.
  - count
```
public static <T> long count(Iterable<T> iterable)
```
    Counts the number of items in the iterator by looping through it.
    
    Type Parameters:
    
    T - the type of items in the iterator.
    
    Parameters:
    
    iterable - the Iterable to count items in.
    
    Returns:
    
    the number of items found in iterable.
  - count
```
public static <T> long count(Iterable<T> iterable,
                             Predicate<T> filter)
```
    Counts the number of filtered items in the iterable by looping through it.
    
    Type Parameters:
    
    T - the type of items in the iterator.
    
    Parameters:
    
    iterable - the Iterable to count items in.
    
    filter - the filter to test items against
    
    Returns:
    
    the number of found in iterable.
  - asCollection
```
public static <T> Collection<T> asCollection(Iterable<T> iterable)
```
    Creates a collection from an iterable.
    
    Type Parameters:
    
    T - The generic type of both the iterable and the collection.
    
    Parameters:
    
    iterable - The iterable to create the collection from.
    
    Returns:
    
    a collection containing all items from the iterable.
  - asList
```
public static <T> List<T> asList(Iterable<T> iterator)
```
  - asMap
```
public static <T,U> Map<T,U> asMap(Iterable<Pair<T,U>> pairs)
```
  - asSet
```
public static <T> Set<T> asSet(Iterable<T> iterable)
```
    Creates a Set from an Iterable.
    
    Type Parameters:
    
    T - The generic type of items.
    
    Parameters:
    
    iterable - The items to create the set from.
    
    Returns:
    
    a set containing all items from the Iterable.
  - asUniqueSet
```
public static <T> Set<T> asUniqueSet(Iterable<T> iterable)
```
    Creates a Set from an Iterable.
    
    Type Parameters:
    
    T - The generic type of items.
    
    Parameters:
    
    iterable - The items to create the set from.
    
    Returns:
    
    a set containing all items from the Iterable.
  - asIterable
```
public static Iterable<Long> asIterable(long... array)
```
  - asIterable
```
public static Iterable<Integer> asIterable(int... array)
```
  - asIterable
```
@SafeVarargs
public static <T> Iterable<T> asIterable(T... array)
```
  - resourceIterable
```
public static <T> org.neo4j.graphdb.ResourceIterable<T> resourceIterable(Iterable<T> iterable)
```
  - indexOf
```
public static <T> int indexOf(T itemToFind,
                              Iterable<T> iterable)
```
    Returns the index of the first occurrence of the specified element in this iterable, or -1 if this iterable does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Type Parameters:
    
    T - the type of the elements
    
    Parameters:
    
    itemToFind - element to find
    
    iterable - iterable to look for the element in
    
    Returns:
    
    the index of the first occurrence of the specified element (or null if that was specified) or -1
  - option
```
public static <T> Iterable<T> option(T item)
```
  - sort
```
public static <T,S extends Comparable> Iterable<T> sort(Iterable<T> iterable,
                                                        Function<T,S> compareFunction)
```
  - join
```
public static String join(String joinString,
                          Iterable<?> iter)
```
  - stream
```
public static <T> Stream<T> stream(Iterable<T> iterable)
```
    Create a stream from the given iterable.
    Note: returned stream needs to be closed via BaseStream.close() if the given iterable implements Resource.
    
    Type Parameters:
    
    T - the type of elements in the given iterable
    
    Parameters:
    
    iterable - the iterable to convert to stream
    
    Returns:
    
    stream over the iterable elements
    
    Throws:
    
    NullPointerException - when the given iterable is null
  - stream
```
public static <T> Stream<T> stream(Iterable<T> iterable,
                                   int characteristics)
```
    Create a stream from the given iterable with given characteristics.
    Note: returned stream needs to be closed via BaseStream.close() if the given iterable implements Resource.
    
    Type Parameters:
    
    T - the type of elements in the given iterable
    
    Parameters:
    
    iterable - the iterable to convert to stream
    
    characteristics - the logical OR of characteristics for the underlying Spliterator
    
    Returns:
    
    stream over the iterable elements
    
    Throws:
    
    NullPointerException - when the given iterable is null
  - enumNames
```
public static <T extends Enum<T>> List<String> enumNames(Class<T> cls)
```

Class Iterables

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

emptyResourceIterable

limit

limit

unique

addAll

filter

skip

reverse

flatten

flattenIterable

mix

map

flatMap

iterable

cast

concat

concat

prepend

append

cache

asArray

asArray

asResourceIterable

toString

firstOrNull

first

lastOrNull

last

singleOrNull

single

single

fromEnd

addToCollection

count

count

asCollection

asList

asMap

asSet

asUniqueSet

asIterable

asIterable

asIterable

resourceIterable

indexOf

option

sort

join

stream

stream

enumNames