Iterators (collections-we 0.2 API)

java.lang.Object
- xyz.cofe.collection.Iterators

```
public class Iterators
extends Object
```
Класс по работе с итераторами

Author:

gocha

Constructor Summary

Constructors
Constructor and Description

Iterators()

Constructors
Constructor and Description
`Iterators()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> void`	`addTo(Iterable<T> src, Collection<T> collection)` Добавляет объекты из последовательности в коллекцию
`static <T> Iterable<T>`	`array(T... array)` Конвертирует массив в итератор
`static <T> List<T>`	`asList(Iterable<T> src)` Возвращает список из последовательности
`static <T> Iterable<T>`	`buffer(Iterable<T> src)` Итератор использующий буффер объектов.
`static <T> Iterable<T>`	`buffer(Iterable<T> src, List<T> buffer)` Итератор использующий буффер объектов.
`static <From,To> Iterable<To>`	`convert(From[] src, Convertor<From,To> convertor)` Возвращает последовательность содержащую объекты сконвертированные в другой тип данных
`static <From,To> Iterable<To>`	`convert(Iterable<From> src, Convertor<From,To> convertor)` Возвращает последовательность содержащую объекты сконвертированные в другой тип данных
`static <T> long`	`count(Iterable<T> src)` Подсчитывает кол-во элементов в последовательности
`static <T> Iterable<T>`	`empty()` Возвращает пустую последовательность объектов
`static boolean`	`in(Object v, Iterable src)` Проверяет находится ли объект в последовательности
`static boolean`	`in(Object v, Object[] src)` Проверяет находится ли объект в массиве
`static <T> Iterable<T>`	`lazy(LazyValue<T> lazyValue)` Возвращает последовательность с одним элементом
`static <T> Iterable<T>`	`max(Iterable<T> src, Comparator<T> cmp)` Итератор возвращающий максимальные значения из указанй последовательности
`static <T> Iterable<T>`	`min(Iterable<T> src, Comparator<T> cmp)` Итератор возвращающий минимальные значения из указанй последовательности
`static <T> Iterable<T>`	`notNullFilter(Iterable<T> src)` Итератор фильтр - не возвращает пустые ссылки
`static <T> Iterable<T>`	`predicate(Iterable<T> src, Predicate<T> predicate)` Возвращает последовательность содержащую только те объекты, которые удалетворяют предикату
`static <T> Iterable<T>`	`predicate(T[] src, Predicate<T> predicate)` Возвращает последовательность содержащую только те объекты, которые удалетворяют предикату
`static <T> Iterable<T>`	`reverse(Iterable<T> src)` Создает обратную последовательность значений
`static <T> Iterable<T>`	`sequence(Iterable<Iterable<T>> src)` Итератор объеденяющий последовательность значений заданых другими итераторами.
`static <T> Iterable<T>`	`sequence(Iterable<T>... src)` Итератор объеденяющий последовательность значений заданых другими итераторами.
`static <T> Iterable<T>`	`set(Iterable<T> src)` Создает последовательность неповторяющихся объектов
`static <T> Iterable<T>`	`set(Iterable<T> src, CompareEqu<T> comparer)`
`static <T> Iterable<T>`	`single(T item)` Возвращает последовательность с одним элементом
`static <T> Iterable<T>`	`sub(Iterable<T> src, Iterable<T> sub)` Вычитает из исходной последовательности объекты заданые второй последовательностью Для примера: Первая последовательность объектов: { A, B, C } Вторая последовательность объектов: { D, E, C } Результирующая последовательность будет: { A, B } В качестве сравнения объектов на равенство будет использоватся метод equals
`static <T> Iterable<T>`	`sub(Iterable<T> src, Iterable<T> sub, Comparator<T> cmp)` Вычитает из исходной последовательности объекты заданые второй последовательностью Для примера: Первая последовательность объектов: { A, B, C } Вторая последовательность объектов: { D, E, C } Результирующая последовательность будет: { A, B }
`static <T> Iterable<T>`	`sub(Iterable<T> src, Iterable<T> sub, CompareEqu<T> cmp)` Вычитает из исходной последовательности объекты заданые второй последовательностью Для примера: Первая последовательность объектов: { A, B, C } Вторая последовательность объектов: { D, E, C } Результирующая последовательность будет: { A, B }
`static <T> Iterable<T>`	`tree(T src, NodesExtracter<T,T> extracter)` Итератор по деверу объектов заданному через интерфес NodesExtracter

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

- Constructor Detail
  - Iterators
```
public Iterators()
```
- Method Detail
  - notNullFilter
```
public static <T> Iterable<T> notNullFilter(Iterable<T> src)
```
    Итератор фильтр - не возвращает пустые ссылки
    
    Type Parameters:
    
    T - Тип объектов
    
    Parameters:
    
    src - Исходная последовательность
    
    Returns:
    
    Ссылки на объекты
  - array
```
public static <T> Iterable<T> array(T... array)
```
    Конвертирует массив в итератор
    
    Type Parameters:
    
    T - Тип объектов
    
    Parameters:
    
    array - Массив
    
    Returns:
    
    Последовательность
  - in
```
public static boolean in(Object v,
                         Object[] src)
```
    Проверяет находится ли объект в массиве
    
    Parameters:
    
    v - Объект
    
    src - Массив
    
    Returns:
    
    true - находиться, false - не находится
  - in
```
public static boolean in(Object v,
                         Iterable src)
```
    Проверяет находится ли объект в последовательности
    
    Parameters:
    
    v - Объект
    
    src - Последовательность
    
    Returns:
    
    true - находиться, false - не находится
  - count
```
public static <T> long count(Iterable<T> src)
```
    Подсчитывает кол-во элементов в последовательности
    
    Type Parameters:
    
    T - Тип объектов
    
    Parameters:
    
    src - Исходная последовательность
    
    Returns:
    
    Кол-во элементов
  - addTo
```
public static <T> void addTo(Iterable<T> src,
                             Collection<T> collection)
```
    Добавляет объекты из последовательности в коллекцию
    
    Type Parameters:
    
    T - Тип объектов
    
    Parameters:
    
    src - Исходная последовательность
    
    collection - Коллекция
  - asList
```
public static <T> List<T> asList(Iterable<T> src)
```
    Возвращает список из последовательности
    
    Type Parameters:
    
    T - Тип объектов
    
    Parameters:
    
    src - Исходная последовательность
    
    Returns:
    
    Список
  - empty
```
public static <T> Iterable<T> empty()
```
    Возвращает пустую последовательность объектов
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Returns:
    
    Пустая последовательность
  - single
```
public static <T> Iterable<T> single(T item)
```
    Возвращает последовательность с одним элементом
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    item - Элемент последовательности
    
    Returns:
    
    Последовательность
  - lazy
```
public static <T> Iterable<T> lazy(LazyValue<T> lazyValue)
```
    Возвращает последовательность с одним элементом
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    lazyValue - Функция возвращающая значение
    
    Returns:
    
    Последовательность с один элементом
  - sequence
```
public static <T> Iterable<T> sequence(Iterable<T>... src)
```
    Итератор объеденяющий последовательность значений заданых другими итераторами.
    Для примера:
    Первая последовательность объектов: { A, B, C }
    Вторая последовательность объектов: { D, E, C }
    Результирующая последовательность будет: { A, B, C, D, E, C }
    
    Type Parameters:
    
    T - Тип данных в итераторе
    
    Parameters:
    
    src - Исходные итераторы
    
    Returns:
    
    Результирующий итератор
  - sequence
```
public static <T> Iterable<T> sequence(Iterable<Iterable<T>> src)
```
    Итератор объеденяющий последовательность значений заданых другими итераторами.
    Для примера:
    Первая последовательность объектов: { A, B, C }
    Вторая последовательность объектов: { D, E, C }
    Результирующая последовательность будет: { A, B, C, D, E, C }
    
    Type Parameters:
    
    T - Тип данных в итераторе
    
    Parameters:
    
    src - Исходные итераторы
    
    Returns:
    
    Результирующий итератор
  - sub
```
public static <T> Iterable<T> sub(Iterable<T> src,
                                  Iterable<T> sub)
```
    Вычитает из исходной последовательности объекты заданые второй последовательностью
    Для примера:
    Первая последовательность объектов: { A, B, C }
    Вторая последовательность объектов: { D, E, C }
    Результирующая последовательность будет: { A, B }
    В качестве сравнения объектов на равенство будет использоватся метод equals
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    sub - Вычитаемая последовательность
    
    Returns:
    
    Результатируемая последовательность
  - sub
```
public static <T> Iterable<T> sub(Iterable<T> src,
                                  Iterable<T> sub,
                                  CompareEqu<T> cmp)
```
    Вычитает из исходной последовательности объекты заданые второй последовательностью
    Для примера:
    Первая последовательность объектов: { A, B, C }
    Вторая последовательность объектов: { D, E, C }
    Результирующая последовательность будет: { A, B }
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    sub - Вычитаемая последовательность
    
    cmp - Интерфес сравнения на равенство объектов
    
    Returns:
    
    Результатируемая последовательность
  - sub
```
public static <T> Iterable<T> sub(Iterable<T> src,
                                  Iterable<T> sub,
                                  Comparator<T> cmp)
```
    Вычитает из исходной последовательности объекты заданые второй последовательностью
    Для примера:
    Первая последовательность объектов: { A, B, C }
    Вторая последовательность объектов: { D, E, C }
    Результирующая последовательность будет: { A, B }
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    sub - Вычитаемая последовательность
    
    cmp - Интерфес сравнения на равенство объектов
    
    Returns:
    
    Результатируемая последовательность
  - buffer
```
public static <T> Iterable<T> buffer(Iterable<T> src)
```
    Итератор использующий буффер объектов. Предварительно копирует объекты в буфер и уже по ним проходит.
    В качестве буфера используется класс java.util.ArrayList
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    Returns:
    
    Копия объектов
  - buffer
```
public static <T> Iterable<T> buffer(Iterable<T> src,
                                     List<T> buffer)
```
    Итератор использующий буффер объектов. Предварительно копирует объекты в буфер и уже по ним проходит.
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    buffer - Буфер объектов
    
    Returns:
    
    Копия объектов
  - predicate
```
public static <T> Iterable<T> predicate(Iterable<T> src,
                                        Predicate<T> predicate)
```
    Возвращает последовательность содержащую только те объекты, которые удалетворяют предикату
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    predicate - Предикат
    
    Returns:
    
    Последовательность значений удалетворяющих предикату
  - predicate
```
public static <T> Iterable<T> predicate(T[] src,
                                        Predicate<T> predicate)
```
    Возвращает последовательность содержащую только те объекты, которые удалетворяют предикату
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    predicate - Предикат
    
    Returns:
    
    Последовательность значений удалетворяющих предикату
  - convert
```
public static <From,To> Iterable<To> convert(Iterable<From> src,
                                             Convertor<From,To> convertor)
```
    Возвращает последовательность содержащую объекты сконвертированные в другой тип данных
    
    Type Parameters:
    
    From - Тип данных из которого необходимо сконвертировать
    
    To - Тип данных в который необходимо сконвертировать
    
    Parameters:
    
    src - Исходная последовательность
    
    convertor - Конвертор типов
    
    Returns:
    
    Последовательность сконвертированых объектов
  - convert
```
public static <From,To> Iterable<To> convert(From[] src,
                                             Convertor<From,To> convertor)
```
    Возвращает последовательность содержащую объекты сконвертированные в другой тип данных
    
    Type Parameters:
    
    From - Тип данных из которого необходимо сконвертировать
    
    To - Тип данных в который необходимо сконвертировать
    
    Parameters:
    
    src - Исходная последовательность
    
    convertor - Конвертор типов
    
    Returns:
    
    Последовательность сконвертированых объектов
  - min
```
public static <T> Iterable<T> min(Iterable<T> src,
                                  Comparator<T> cmp)
```
    Итератор возвращающий минимальные значения из указанй последовательности
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    cmp - Интерфейс сравнения объектов
    
    Returns:
    
    Последовательность содержащая минимальные значения
  - max
```
public static <T> Iterable<T> max(Iterable<T> src,
                                  Comparator<T> cmp)
```
    Итератор возвращающий максимальные значения из указанй последовательности
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    cmp - Интерфейс сравнения объектов
    
    Returns:
    
    Последовательность содержащая максимальные значения
  - reverse
```
public static <T> Iterable<T> reverse(Iterable<T> src)
```
    Создает обратную последовательность значений
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    Returns:
    
    Итератор содержащая обратную последовательность значения
  - set
```
public static <T> Iterable<T> set(Iterable<T> src)
```
    Создает последовательность неповторяющихся объектов
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    Returns:
    
    Последовательнось неповторяющихся объектов
  - set
```
public static <T> Iterable<T> set(Iterable<T> src,
                                  CompareEqu<T> comparer)
```
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Исходная последовательность
    
    comparer - Интерфейс сравнения объектов
    
    Returns:
    
    Последовательнось неповторяющихся объектов
  - tree
```
public static <T> Iterable<T> tree(T src,
                                   NodesExtracter<T,T> extracter)
```
    Итератор по деверу объектов заданному через интерфес NodesExtracter
    
    Type Parameters:
    
    T - Тип значений в последовательностях
    
    Parameters:
    
    src - Корневой объект
    
    extracter - Итерфес доступа к дочерним элементам
    
    Returns:
    
    Последовательность объектов

Class Iterators

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Iterators

Method Detail

notNullFilter

array

in

in

count

addTo

asList

empty

single

lazy

sequence

sequence

sub

sub

sub

buffer

buffer

predicate

predicate

convert

convert

min

max

reverse

set

set

tree