de.unkrig.commons.file.filetransformation

Class FileContentsTransformer

java.lang.Object

de.unkrig.commons.file.filetransformation.FileContentsTransformer

All Implemented Interfaces:

FileTransformer

public class FileContentsTransformer
extends Object
implements FileTransformer

A FileTransformer that transforms a file be feeding its contents through a ContentsTransformer.

Nested Class Summary

Nested classes/interfaces inherited from interface de.unkrig.commons.file.filetransformation.FileTransformer

FileTransformer.Mode

Field Summary

Fields inherited from interface de.unkrig.commons.file.filetransformation.FileTransformer

NOT_IDENTICAL, THROW_NOT_IDENTICAL

Constructor Summary

Constructors

Constructor and Description
FileContentsTransformer(ContentsTransformer contentsTransformer, boolean keepOriginals)

Method Summary

Modifier and Type	Method and Description
static void	checkIdentity(String path, InputStream inputStream, ContentsTransformer contentsTransformer, boolean closeInputStream) Consumes the inputStream, feeds it through the contentsTransformer, and checks whether the output is identical with the input.
void	transform(String path, File in, File out, FileTransformer.Mode mode) Opens the in file for reading, opens the out file for writing, reads the contents, feeds it through the given ContentsTransformer, and writes it to the out file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileContentsTransformer

public FileContentsTransformer(ContentsTransformer contentsTransformer,
                               boolean keepOriginals)

Parameters:

keepOriginals - Whether to keep a copy of the original file; only relevant for in-place transformations

Method Detail

transform

public void transform(String path,
                      File in,
                      File out,
                      FileTransformer.Mode mode)
               throws IOException

Opens the in file for reading, opens the out file for writing, reads the contents, feeds it through the given ContentsTransformer, and writes it to the out file.

Specified by:

transform in interface FileTransformer

Parameters:

path - A text designating the input file; typically, but not necessarily identical with in.getPath()

in - The input file to read

out - The output file to create; irrelevant iff mode == FileTransformer.Mode.CHECK

Throws:

IOException

See Also:

FileTransformer.NOT_IDENTICAL, FileTransformer.Mode.TRANSFORM, FileTransformer.Mode.CHECK, FileTransformer.Mode.CHECK_AND_TRANSFORM

checkIdentity

public static void checkIdentity(String path,
                                 InputStream inputStream,
                                 ContentsTransformer contentsTransformer,
                                 boolean closeInputStream)
                          throws IOException

Consumes the inputStream, feeds it through the contentsTransformer, and checks whether the output is identical with the input.

Throws:

RuntimeException - FileTransformer.NOT_IDENTICAL iff the transformer contents differs from the original contents

IOException