net.webpdf.ant.task.files

Class IterativeTaskFileMap

java.lang.Object

net.webpdf.ant.task.files.IterativeTaskFileMap

All Implemented Interfaces:

Iterable<IterativeTaskFile>

public class IterativeTaskFileMap
extends Object
implements Iterable<IterativeTaskFile>

The TaskFileCollection collects all files, that the current webPDF task shall be executed for. An instance of this class will also provide information about the used and needed directories. It also provides a mapping from each individual source file to the intended target file name.

Constructor Summary

Constructors

Constructor and Description
IterativeTaskFileMap() A collection for all source files, that shall be processed by the current webPDF task.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.tools.ant.types.ResourceCollection resourceCollection) Will add each resource defined in the given collection.
File	getTargetDirectory() Shall return the directory the final result shall be placed in.
File	getTargetFile() Returns the file the final result shall be copied to.
TempDir	getTempDir()
Iterator<IterativeTaskFile>	iterator() An iterator over all source/name mappings of this collection.
void	replaceWithInputVar(Variable input) Overrides the currently set resources with a manually set input variable.
void	setMapper(org.apache.tools.ant.util.FileNameMapper fileNameMapper) Initializes the mapper, that will be used to deduce target file names for source files.
void	setTargetDirectory(File targetDirectory) Sets the directory the final result shall be placed in.
void	setTargetFile(File targetFile) Sets the explicit file the final result shall be copied to.
void	setTempDir(File tempDir) Sets the directory temporary files shall be created in.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeTaskFileMap

public IterativeTaskFileMap()

A collection for all source files, that shall be processed by the current webPDF task.

Method Detail

setTempDir

public void setTempDir(File tempDir)
                throws org.apache.tools.ant.BuildException

Sets the directory temporary files shall be created in.

Parameters:

tempDir - The directory temporary files shall be created in.

Throws:

org.apache.tools.ant.BuildException - Shall be thrown if the given directory is invalid or inaccessible.

getTempDir

public TempDir getTempDir()

setTargetDirectory

public void setTargetDirectory(File targetDirectory)
                        throws org.apache.tools.ant.BuildException

Sets the directory the final result shall be placed in.

Parameters:

targetDirectory - The directory the final result shall be placed in.

Throws:

org.apache.tools.ant.BuildException - Shall be thrown if the given directory is invalid or inaccessible.

getTargetDirectory

public File getTargetDirectory()

Shall return the directory the final result shall be placed in.

Returns:

The directory the final result shall be placed in.

setTargetFile

public void setTargetFile(File targetFile)

Sets the explicit file the final result shall be copied to.

Parameters:

targetFile - The file the final result shall be copied to.

getTargetFile

public File getTargetFile()

Returns the file the final result shall be copied to.

Returns:

The file the final result shall be copied to.

add

public void add(org.apache.tools.ant.types.ResourceCollection resourceCollection)

Will add each resource defined in the given collection.

Parameters:

resourceCollection - The collection, that shall be appended to this task file collection.

setMapper

public void setMapper(org.apache.tools.ant.util.FileNameMapper fileNameMapper)
               throws org.apache.tools.ant.BuildException

Initializes the mapper, that will be used to deduce target file names for source files.

Parameters:

fileNameMapper - The mapper, that will be used to deduce target file names for source files.

Throws:

org.apache.tools.ant.BuildException - Shall be thrown if the mapper is not valid, or if a valid mapper has already been set.

replaceWithInputVar

public void replaceWithInputVar(Variable input)
                         throws IOException

Overrides the currently set resources with a manually set input variable.

Parameters:

input - The input variable, that shall replace the currently set resources.

Throws:

IOException - Shall be thrown, if the given file can not be accessed.

iterator

public Iterator<IterativeTaskFile> iterator()

An iterator over all source/name mappings of this collection.

Specified by:

iterator in interface Iterable<IterativeTaskFile>

Returns:

An iterator for this collection.