org.apache.tools.ant.taskdefs
public class ExecuteOn extends ExecTask
Since: Ant 1.2
UNKNOWN: category="control" name="apply"
Nested Class Summary | |
---|---|
static class | ExecuteOn.FileDirBoth
Enumerated attribute with the values "file", "dir" and "both"
for the type attribute. |
Field Summary | |
---|---|
protected File | destDir |
protected Vector | filesets |
protected FileNameMapper | mapper |
protected Mapper | mapperElement |
protected Commandline.Marker | srcFilePos |
protected boolean | srcIsFirst
Has <srcfile> been specified before <targetfile> |
protected Commandline.Marker | targetFilePos |
protected String | type |
Method Summary | |
---|---|
void | add(ResourceCollection rc)
Add a collection of resources upon which to operate. |
void | add(FileNameMapper fileNameMapper)
Add a nested FileNameMapper. |
void | addDirset(DirSet set)
Add a set of directories upon which to operate.
|
void | addFilelist(FileList list)
Add a list of source files upon which to operate. |
void | addFileset(FileSet set)
Add a set of files upon which to operate. |
protected void | checkConfiguration()
Check the configuration of this ExecuteOn instance. |
protected ExecuteStreamHandler | createHandler()
Create the ExecuteStreamHandler instance that will be used
during execution. |
Mapper | createMapper()
Create a nested Mapper element to use for mapping
source files to target files. |
Commandline.Marker | createSrcfile()
Create a placeholder indicating where on the command line
the name of the source file should be inserted. |
Commandline.Marker | createTargetfile()
Create a placeholder indicating where on the command line
the name of the target file should be inserted. |
protected String[] | getCommandline(String[] srcFiles, File[] baseDirs)
Construct the command line for parallel execution.
|
protected String[] | getCommandline(String srcFile, File baseDir)
Construct the command line for serial execution.
|
protected String[] | getDirs(File baseDir, DirectoryScanner ds)
Return the list of Directories from this DirectoryScanner that
should be included on the command line. |
protected String[] | getFiles(File baseDir, DirectoryScanner ds)
Return the list of files from this DirectoryScanner that should
be included on the command line. |
protected String[] | getFilesAndDirs(FileList list)
Return the list of files or directories from this FileList that
should be included on the command line. |
protected void | runExec(Execute exe)
Run the specified Execute object. |
protected void | runParallel(Execute exe, Vector fileNames, Vector baseDirs)
Run the command in "parallel" mode, making sure that at most
maxParallel sourcefiles get passed on the command line. |
void | setAddsourcefile(boolean b)
Set whether to send the source file name on the command line.
|
void | setDest(File destDir)
Specify the directory where target files are to be placed. |
void | setForce(boolean b)
Set whether to bypass timestamp comparisons for target files. |
void | setForwardslash(boolean forwardSlash)
Set whether the source and target file names on Windows and OS/2
must use the forward slash as file separator. |
void | setIgnoremissing(boolean b)
Set whether to ignore nonexistent files from filelists. |
void | setMaxParallel(int max)
Limit the command line length by passing at maximum this many
sourcefiles at once to the command.
|
void | setParallel(boolean parallel)
Set whether to execute in parallel mode.
|
void | setRelative(boolean relative)
Set whether the filenames should be passed on the command line as
absolute or relative pathnames. |
void | setSkipEmptyFilesets(boolean skip)
Set whether empty filesets will be skipped. |
void | setType(ExecuteOn.FileDirBoth type)
Set whether the command works only on files, directories or both. |
protected void | setupRedirector()
Set up the I/O Redirector. |
void | setVerbose(boolean b)
Set whether to operate in verbose mode.
|
Parameters: rc resource collection to add.
Since: Ant 1.7
Parameters: fileNameMapper the mapper to add.
Since: Ant 1.6.3
Parameters: set the DirSet to add.
Since: Ant 1.6
Parameters: list the FileList to add.
Parameters: set the FileSet to add.
Returns: ExecuteStreamHandler
.
Throws: BuildException on error.
Returns: Mapper
.
Throws: BuildException if more than one mapper is defined.
Returns: Commandline.Marker
.
Returns: Commandline.Marker
.
Parameters: srcFiles The filenames to add to the commandline. baseDirs filenames are relative to this dir.
Returns: the command line in the form of a String[].
Parameters: srcFile The filename to add to the commandline. baseDir filename is relative to this dir.
Returns: the command line in the form of a String[].
Parameters: baseDir the File base directory. ds the DirectoryScanner to use for file scanning.
Returns: a String[] containing the directory names.
Parameters: baseDir the File base directory. ds the DirectoryScanner to use for file scanning.
Returns: a String[] containing the filenames.
Parameters: list the FileList to check.
Returns: a String[] containing the directory names.
Since: Ant 1.6.2
Parameters: exe the Execute instance representing the external process.
Throws: BuildException on error
Parameters: exe the Executable to use. fileNames the Vector of filenames. baseDirs the Vector of base directories corresponding to fileNames.
Throws: IOException on I/O errors. BuildException on other errors.
Since: Ant 1.6
Defaults to true
.
Parameters: b whether to add the source file to the command line.
Since: Ant 1.6
Parameters: destDir the File object representing the destination directory.
Parameters: b whether to bypass timestamp comparisons.
Since: Ant 1.6.3
Parameters: forwardSlash whether the forward slash will be forced.
Parameters: b whether to ignore missing files.
Since: Ant 1.6.2
Set to <= 0 for unlimited - this is the default.
Parameters: max int
maximum number of sourcefiles
passed to the executable.
Since: Ant 1.6
Parameters: parallel whether to run in parallel.
Parameters: relative whether to pass relative pathnames.
Parameters: skip whether to skip empty filesets.
Parameters: type a FileDirBoth EnumeratedAttribute.
Parameters: b whether to operate in verbose mode.
Since: Ant 1.6