de.unkrig.commons.file.fileprocessing

Class FileContentsProcessor<T>

java.lang.Object

de.unkrig.commons.file.fileprocessing.FileContentsProcessor<T>

Type Parameters:

T - The type that process(String, File) returns; use "Void" if not needed

All Implemented Interfaces:

FileProcessor<T>

public class FileContentsProcessor<T>
extends Object
implements FileProcessor<T>

Processes a file by opening the file, feeding its contents to the ContentsProcessor, and eventually closing the file.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentsProcessor<T>	contentsProcessor The ContentsProcessor that is used to process a file's contents when process(String, File) is invoked.

Constructor Summary

Constructors

Constructor and Description
FileContentsProcessor(ContentsProcessor<T> contentsProcessor)

Method Summary

Modifier and Type	Method and Description
T	process(String path, File file) Opens the file, passes the input stream to ContentsProcessor.process(String, InputStream, long, long, ProducerWhichThrows), then closes the file.

Methods inherited from class java.lang.Object

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

Field Detail

contentsProcessor

protected final ContentsProcessor<T> contentsProcessor

The ContentsProcessor that is used to process a file's contents when process(String, File) is invoked.

Constructor Detail

FileContentsProcessor

public FileContentsProcessor(ContentsProcessor<T> contentsProcessor)

Method Detail

process

@Nullable
public T process(String path,
                            File file)
                     throws FileNotFoundException,
                            IOException

Opens the file, passes the input stream to ContentsProcessor.process(String, InputStream, long, long, ProducerWhichThrows), then closes the file.

Subclasses may override this behavior, e.g. by recursing into directories or archives.

Specified by:

process in interface FileProcessor<T>

Parameters:

path - The string that characterizes the file

Throws:

IOException - Message should include the file name

FileNotFoundException