de.unkrig.commons.file.filetransformation

Class DirectoryTransformer

java.lang.Object

de.unkrig.commons.file.filetransformation.DirectoryTransformer

All Implemented Interfaces:

FileTransformer

public class DirectoryTransformer
extends Object
implements FileTransformer

See Also:

transform(String, File, File, de.unkrig.commons.file.filetransformation.FileTransformer.Mode)

Nested Class Summary

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

FileTransformer.Mode

Field Summary

Fields

Modifier and Type	Field and Description
static Collator	DEFAULT_MEMBER_NAME_COMPARATOR Sorts ascendingly by name (for the default locale).

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

NOT_IDENTICAL, THROW_NOT_IDENTICAL

Constructor Summary

Constructors

Constructor and Description
DirectoryTransformer(FileTransformer regularFileTransformer, Comparator<Object> directoryMemberNameComparator, FileTransformer directoryMemberTransformer, FileTransformations.DirectoryCombiner directoryCombiner, boolean saveSpace, boolean keepOriginals, ExceptionHandler<IOException> exceptionHandler)

Method Summary

Modifier and Type	Method and Description
String	toString()
void	transform(String path, File in, File out, FileTransformer.Mode mode) If in is a directory, then out is taken as a directory (created if missing), and directoryMemberTransformer.transform() is called for each member of in.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MEMBER_NAME_COMPARATOR

public static final Collator DEFAULT_MEMBER_NAME_COMPARATOR

Sorts ascendingly by name (for the default locale).

A good default value for the memberNameComparator parameter of DirectoryTransformer(FileTransformer, Comparator, FileTransformer, FileTransformations.DirectoryCombiner, boolean, boolean, ExceptionHandler).

See Also:

DirectoryTransformer(FileTransformer, Comparator, FileTransformer, FileTransformations.DirectoryCombiner, boolean, boolean, ExceptionHandler)

Constructor Detail

DirectoryTransformer

public DirectoryTransformer(FileTransformer regularFileTransformer,
                            @Nullable
                            Comparator<Object> directoryMemberNameComparator,
                            FileTransformer directoryMemberTransformer,
                            FileTransformations.DirectoryCombiner directoryCombiner,
                            boolean saveSpace,
                            boolean keepOriginals,
                            ExceptionHandler<IOException> exceptionHandler)

Parameters:

directoryMemberNameComparator - The comparator used to sort a directory's members; a null value means to NOT sort the members, i.e. leave them in their 'natural' order as File.list() returns them

See Also:

FileTransformer.transform(String, File, File, Mode), DEFAULT_MEMBER_NAME_COMPARATOR

Method Detail

transform

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

If in is a directory, then out is taken as a directory (created if missing), and directoryMemberTransformer.transform() is called for each member of in.

If that method throws an IOException or a RuntimeException, then that exception is caught, and exceptionHandler.handle() is called. (This includes the case when FileTransformer.NOT_IDENTICAL is thrown in mode FileTransformer.Mode.CHECK.)

If "exceptionHandler.ExceptionHandler.handle(String, RuntimeException)" completes normally (i.e. it doesn't throw an exception), then processing continues with the next member of directory in.

Iff in is not a directory, then the regularFileTransformer is invoked.

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

toString

public String toString()

Overrides:

toString in class Object