Package arc.packer

Class FileProcessor

java.lang.Object

arc.packer.FileProcessor

Direct Known Subclasses:

TexturePackerFileProcessor

public class FileProcessor
extends Object

Collects files recursively, filtering by file name. Callbacks are provided to process files and the results are collected, either processFile(Entry) or processDir(Entry, Seq) can be overridden, or both. The entries provided to the callbacks have the original file, the output directory, and the output file. If setFlattenOutput(boolean) is false, the output will match the directory structure of the input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileProcessor.Entry

Constructor Summary

Constructors

Constructor	Description
FileProcessor()
FileProcessor(FileProcessor processor)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
FileProcessor	addInputRegex(String... regexes)
FileProcessor	addInputSuffix(String... suffixes)	Adds a case insensitive suffix for matching input files.
protected void	addProcessedFile(FileProcessor.Entry entry)	This method should be called by processFile(Entry) or processDir(Entry, Seq) if the return value of process(File, File) or process(File[], File) should return all the processed files.
Seq<FileProcessor.Entry>	process(File[] files, File outputRoot)	Processes the specified input files.
Seq<FileProcessor.Entry>	process(File inputFileOrDir, File outputRoot)	Processes the specified input file or directory.
Seq<FileProcessor.Entry>	process(String inputFileOrDir, String outputRoot)
protected void	processDir(FileProcessor.Entry entryDir, Seq<FileProcessor.Entry> files)	Called for each input directory.
protected void	processFile(FileProcessor.Entry entry)	Called with each input file.
FileProcessor	setComparator(Comparator<File> comparator)	Sets the comparator for processDir(Entry, Seq).
FileProcessor	setFlattenOutput(boolean flattenOutput)
FileProcessor	setInputFilter(FilenameFilter inputFilter)
FileProcessor	setOutputSuffix(String outputSuffix)	Sets the suffix for output files, replacing the extension of the input file.
FileProcessor	setRecursive(boolean recursive)	Default is true.

Methods inherited from class java.lang.Object

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

Constructor Details

FileProcessor

public FileProcessor()

FileProcessor

public FileProcessor(FileProcessor processor)

Copy constructor.

Method Details

setInputFilter

public FileProcessor setInputFilter(FilenameFilter inputFilter)

setComparator

public FileProcessor setComparator(Comparator<File> comparator)

Sets the comparator for processDir(Entry, Seq). By default the files are sorted by alpha.

addInputSuffix

public FileProcessor addInputSuffix(String... suffixes)

Adds a case insensitive suffix for matching input files.

addInputRegex

public FileProcessor addInputRegex(String... regexes)

setOutputSuffix

public FileProcessor setOutputSuffix(String outputSuffix)

Sets the suffix for output files, replacing the extension of the input file.

setFlattenOutput

public FileProcessor setFlattenOutput(boolean flattenOutput)

setRecursive

public FileProcessor setRecursive(boolean recursive)

Default is true.

process

public Seq<FileProcessor.Entry> process(String inputFileOrDir,
 String outputRoot)
                                 throws Exception

Parameters:

outputRoot - May be null.

Throws:

Exception

See Also:

• process(File, File)

process

public Seq<FileProcessor.Entry> process(File inputFileOrDir,
 File outputRoot)
                                 throws Exception

Processes the specified input file or directory.

Parameters:

outputRoot - May be null if there is no output from processing the files.

Returns:

the processed files added with addProcessedFile(Entry).

Throws:

Exception

process

public Seq<FileProcessor.Entry> process(File[] files,
 File outputRoot)
                                 throws Exception

Processes the specified input files.

Parameters:

outputRoot - May be null if there is no output from processing the files.

Returns:

the processed files added with addProcessedFile(Entry).

Throws:

Exception

processFile

protected void processFile(FileProcessor.Entry entry)
                    throws Exception

Called with each input file.

Throws:

Exception

processDir

protected void processDir(FileProcessor.Entry entryDir,
 Seq<FileProcessor.Entry> files)
                   throws Exception

Called for each input directory. The files will be sorted. The specified files list can be modified to change which files are processed.

Throws:

Exception

addProcessedFile

protected void addProcessedFile(FileProcessor.Entry entry)

This method should be called by processFile(Entry) or processDir(Entry, Seq) if the return value of process(File, File) or process(File[], File) should return all the processed files.