Traversers (hazelcast-jet-all 0.4 API)

java.lang.Object
- com.hazelcast.jet.Traversers

```
public final class Traversers
extends Object
```
Utility class with several Traversers useful in Processor implementations.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Traverser<T>`	`empty()` Returns a traverser that always returns null.
`static <T> Traverser<T>`	`enumerate(Enumeration<T> enumeration)` Returns a simple adapter from `Enumeration` to `Traverser`.
`static <T> Traverser<T>`	`iterate(Iterator<T> iterator)` Returns a simple adapter from `Iterator` to `Traverser`.
`static <T> Traverser<T>`	`lazy(java.util.function.Supplier<Traverser<T>> supplierOfTraverser)` Flattens a supplier of traverser into a lazy-initialized traverser.
`static <T> Traverser<T>`	`spliterate(Spliterator<T> spliterator)` Returns a simple adapter from `Spliterator` to `Traverser`.
`static <T> Traverser<T>`	`traverseArray(T[] array)` Returns a traverser over the given array.
`static <T> Traverser<T>`	`traverseIterable(Iterable<T> iterable)` Returns a traverser over the given iterable.
`static <T> Traverser<T>`	`traverseStream(java.util.stream.Stream<T> stream)` Returns a traverser over the given stream.

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

Method Detail

empty

@Nonnull
public static <T> Traverser<T> empty()

Returns a traverser that always returns null.

iterate
```
@Nonnull
public static <T> Traverser<T> iterate(@Nonnull
                                                Iterator<T> iterator)
```
Returns a simple adapter from Iterator to Traverser. The iterator must return non-null items. Each time its next() method is called, the traverser will take another item from the iterator and return it.

spliterate

@Nonnull
public static <T> Traverser<T> spliterate(@Nonnull
                                                   Spliterator<T> spliterator)

Returns a simple adapter from Spliterator to Traverser. Each time its next() method is called, the traverser will take another item from the spliterator and return it.

enumerate
```
@Nonnull
public static <T> Traverser<T> enumerate(@Nonnull
                                                  Enumeration<T> enumeration)
```
Returns a simple adapter from Enumeration to Traverser. The enumeration must return non-null items. Each time its next() method is called, the traverser will take another item from the enumeration and return it.

traverseStream

@Nonnull
public static <T> Traverser<T> traverseStream(@Nonnull
                                                       java.util.stream.Stream<T> stream)

Returns a traverser over the given stream. The stream is traversed through its spliterator, which is obtained immediately.

traverseIterable

@Nonnull
public static <T> Traverser<T> traverseIterable(@Nonnull
                                                         Iterable<T> iterable)

Returns a traverser over the given iterable. The iterator is obtained immediately.

traverseArray

@Nonnull
public static <T> Traverser<T> traverseArray(@Nonnull
                                                      T[] array)

Returns a traverser over the given array.

lazy

@Nonnull
public static <T> Traverser<T> lazy(@Nonnull
                                             java.util.function.Supplier<Traverser<T>> supplierOfTraverser)

Flattens a supplier of traverser into a lazy-initialized traverser. The traverser is obtained from this method's argument just once, upon the first invocation of get().

Class Traversers