Package org.apache.jackrabbit.oak.commons.io

Class BurnOnCloseFileIterator<T>

java.lang.Object

org.apache.jackrabbit.oak.commons.io.BurnOnCloseFileIterator<T>

Type Parameters:

T - the type of elements in the iterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<T>

public class BurnOnCloseFileIterator<T>
extends Object
implements Closeable, Iterator<T>

Implements a Closeable wrapper over a LineIterator. Also has a transformer to transform the output. If the underlying file is provided then it deletes the file on close(). If there is a scope for lines in the file containing line break characters it should be ensured that the files is written with FileIOUtils.writeAsLine(BufferedWriter, String, boolean) with true to escape line break characters and should be properly unescaped on read. A custom transformer can also be provided to unescape.

Constructor Summary

Constructors

Constructor	Description
BurnOnCloseFileIterator(Iterator<String> iterator, File backingFile, Function<String,T> transformer)
BurnOnCloseFileIterator(Iterator<String> iterator, Function<String,T> transformer)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasNext()
T	next()
static BurnOnCloseFileIterator<String>	wrap(Iterator<String> iter)
static BurnOnCloseFileIterator<String>	wrap(Iterator<String> iter, File backingFile)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

BurnOnCloseFileIterator

public BurnOnCloseFileIterator(Iterator<String> iterator,
                               Function<String,T> transformer)

BurnOnCloseFileIterator

public BurnOnCloseFileIterator(Iterator<String> iterator,
                               File backingFile,
                               Function<String,T> transformer)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

wrap

public static BurnOnCloseFileIterator<String> wrap(Iterator<String> iter)

wrap

public static BurnOnCloseFileIterator<String> wrap(Iterator<String> iter,
                                                   File backingFile)