StreamIterable (uk.gov.gchq.gaffer:gaffer2 2.3.1 API)

java.lang.Object
- uk.gov.gchq.gaffer.commonutil.iterable.StreamIterable<T>

Type Parameters:

T - the object type

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

StreamFilterIterable, StreamFlatMapIterable, StreamMapIterable, StreamTransformIterable
```
public class StreamIterable<T>
extends Object
implements Closeable, Iterable<T>
```
A Closeable Iterable which uses a Stream as the underlying data source.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  StreamIterable(Supplier<Stream<T>> streamSupplier)
  
  StreamIterable(StreamSupplier<T> streamSupplier)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  void close()
  
  Stream<T> getStream()
  Get a Stream from the StreamSupplier.
  
  Iterator<T> iterator()
  - Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface java.lang.Iterable
    forEach, spliterator

- Constructor Detail
  - StreamIterable
```
public StreamIterable(StreamSupplier<T> streamSupplier)
```
  - StreamIterable
```
public StreamIterable(Supplier<Stream<T>> streamSupplier)
```
- Method Detail
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - getStream
```
public Stream<T> getStream()
```
    Get a Stream from the StreamSupplier.
    This enables the creation of multiple stream objects from the same base data, without operating on the same stream multiple times.
    
    Returns:
    
    a new Stream