org.apache.jackrabbit.oak.commons

Class FileIOUtils.BurnOnCloseFileIterator<T>

java.lang.Object

com.google.common.collect.UnmodifiableIterator<T>

com.google.common.collect.AbstractIterator<T>

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

Type Parameters:

T - the type of elements in the iterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<T>

Enclosing class:

FileIOUtils

public static class FileIOUtils.BurnOnCloseFileIterator<T>
extends com.google.common.collect.AbstractIterator<T>
implements Closeable

Implements a Closeable wrapper over a LineIterator. Also has a transformer to transform the output. If the underlying file is provide 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 and Description
BurnOnCloseFileIterator(org.apache.commons.io.LineIterator iterator, File backingFile, com.google.common.base.Function<String,T> transformer)
BurnOnCloseFileIterator(org.apache.commons.io.LineIterator iterator, com.google.common.base.Function<String,T> transformer)

Method Summary

Modifier and Type	Method and Description
void	close()
protected T	computeNext()
static FileIOUtils.BurnOnCloseFileIterator<String>	wrap(org.apache.commons.io.LineIterator iter)
static FileIOUtils.BurnOnCloseFileIterator<String>	wrap(org.apache.commons.io.LineIterator iter, File backingFile)

Methods inherited from class com.google.common.collect.AbstractIterator

endOfData, hasNext, next, peek

Methods inherited from class com.google.common.collect.UnmodifiableIterator

remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

BurnOnCloseFileIterator

public BurnOnCloseFileIterator(org.apache.commons.io.LineIterator iterator,
                               com.google.common.base.Function<String,T> transformer)

BurnOnCloseFileIterator

public BurnOnCloseFileIterator(org.apache.commons.io.LineIterator iterator,
                               File backingFile,
                               com.google.common.base.Function<String,T> transformer)

Method Detail

computeNext

protected T computeNext()

Specified by:

computeNext in class com.google.common.collect.AbstractIterator<T>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

wrap

public static FileIOUtils.BurnOnCloseFileIterator<String> wrap(org.apache.commons.io.LineIterator iter)

wrap

public static FileIOUtils.BurnOnCloseFileIterator<String> wrap(org.apache.commons.io.LineIterator iter,
                                                               File backingFile)