Package uk.gov.gchq.gaffer.commonutil.iterable

Class TransformIterable<I,O>

java.lang.Object

uk.gov.gchq.gaffer.commonutil.iterable.TransformIterable<I,O>

Type Parameters:

I - The input iterable type.

O - the output iterable type.

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<O>

Direct Known Subclasses:

ValidatedElements

public abstract class TransformIterable<I,O>
extends Object
implements Closeable, Iterable<O>

A TransformIterable allows Iterables to be lazily validated and transformed without loading the entire iterable into memory. The easiest way to use this class is to create an anonymous inner class.

Constructor Summary

Constructors

Constructor	Description
TransformIterable(Iterable<? extends I> input)	Constructs an TransformIterable with the given input Iterable and no validation.
TransformIterable(Iterable<? extends I> input, Validator<I> validator)	Constructs an TransformIterable with the given input Iterable and Validator.
TransformIterable(Iterable<? extends I> input, Validator<I> validator, boolean skipInvalid)	Constructs an TransformIterable with the given input Iterable, Validator and a skipInvalid flag to determine whether invalid items should be skipped.
TransformIterable(Iterable<? extends I> input, Validator<I> validator, boolean skipInvalid, boolean autoClose)	Constructs an TransformIterable with the given parameters

Method Summary

Modifier and Type	Method	Description
void	close()
Iterator<O>	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

TransformIterable

public TransformIterable(Iterable<? extends I> input)

Constructs an TransformIterable with the given input Iterable and no validation.

Parameters:

input - the input Iterable

TransformIterable

public TransformIterable(Iterable<? extends I> input,
                         Validator<I> validator)

Constructs an TransformIterable with the given input Iterable and Validator. Invalid items will throw an IllegalArgumentException to be thrown.

Parameters:

input - the input Iterable

validator - the Validator

TransformIterable

public TransformIterable(Iterable<? extends I> input,
                         Validator<I> validator,
                         boolean skipInvalid)

Constructs an TransformIterable with the given input Iterable, Validator and a skipInvalid flag to determine whether invalid items should be skipped.

Parameters:

input - the input Iterable

validator - the Validator

skipInvalid - if true invalid items should be skipped

TransformIterable

public TransformIterable(Iterable<? extends I> input,
                         Validator<I> validator,
                         boolean skipInvalid,
                         boolean autoClose)

Constructs an TransformIterable with the given parameters

Parameters:

input - the input Iterable

validator - the Validator

skipInvalid - if true invalid items should be skipped

autoClose - if true then the input iterable will be closed when any iterators reach the end.

Method Detail

iterator

public Iterator<O> iterator()

Specified by:

iterator in interface Iterable<I>

Returns:

an Iterator that lazy transforms the I items to O items

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable