Apache Ant Core 1.10.14 · org.apache.tools.ant.taskdefs.ExecuteOn

Modifier and Type	Class and Description
public static class	ExecuteOn.FileDirBoth Enumerated attribute with the values "file", "dir" and "both" for the type attribute.

Modifier and Type	Field and Description
private boolean	addSourceFile
protected File	destDir
protected Vector<AbstractFileSet>	filesets
private boolean	force
private boolean	forwardSlash
private boolean	ignoreMissing
protected FileNameMapper	mapper
protected Mapper	mapperElement
private int	maxParallel
private boolean	parallel
private boolean	relative
private Union	resources
private boolean	skipEmpty
protected Commandline.Marker	srcFilePos
protected boolean	srcIsFirst Has <srcfile> been specified before <targetfile>
protected Commandline.Marker	targetFilePos
protected String	type
private boolean	verbose

Access	Constructor and Description
public	ExecuteOn()

Method Summary

Modifier and Type	Method and Description
public void	add(ResourceCollection resource collection to add. rc) Add a collection of resources upon which to operate.
public void	add(FileNameMapper the mapper to add. fileNameMapper) Add a nested FileNameMapper.
public void	addDirset(DirSet the DirSet to add. set) Add a set of directories upon which to operate.
public void	addFilelist(FileList the FileList to add. list) Add a list of source files upon which to operate.
public void	addFileset(FileSet the FileSet to add. set) Add a set of files upon which to operate.
protected void	checkConfiguration() Overrides org.apache.tools.ant.taskdefs.ExecTask.checkConfiguration. Check the configuration of this ExecuteOn instance.
protected ExecuteStreamHandler	Returns: `ExecuteStreamHandler`. createHandler() Overrides org.apache.tools.ant.taskdefs.ExecTask.createHandler. Create the ExecuteStreamHandler instance that will be used during execution.
public Mapper	Returns: `Mapper`. createMapper() Create a nested Mapper element to use for mapping source files to target files.
public Commandline.Marker	Returns: `Commandline.Marker`. createSrcfile() Create a placeholder indicating where on the command line the name of the source file should be inserted.
public Commandline.Marker	Returns: `Commandline.Marker`. createTargetfile() Create a placeholder indicating where on the command line the name of the target file should be inserted.
protected String[]	Returns: the command line in the form of a String[]. getCommandline(String[] The filenames to add to the commandline. srcFiles, File[] filenames are relative to this dir. baseDirs) Construct the command line for parallel execution.
protected String[]	Returns: the command line in the form of a String[]. getCommandline(String The filename to add to the commandline. srcFile, File filename is relative to this dir. baseDir) Construct the command line for serial execution.
protected String[]	Returns: a String[] containing the directory names. getDirs(File the File base directory. baseDir, DirectoryScanner the DirectoryScanner to use for file scanning. ds) Return the list of Directories from this DirectoryScanner that should be included on the command line.
protected String[]	Returns: a String[] containing the filenames. getFiles(File the File base directory. baseDir, DirectoryScanner the DirectoryScanner to use for file scanning. ds) Return the list of files from this DirectoryScanner that should be included on the command line.
protected String[]	Returns: a String[] containing the directory names. getFilesAndDirs(FileList the FileList to check. list) Return the list of files or directories from this FileList that should be included on the command line.
private static void	insertTargetFiles(String[] targetFiles, String[] arguments, int insertPosition, String prefix, String suffix) Inserts target file names (which are already absolute paths) into the list of arguments, taking prefix and postfix into account.
private void	logSkippingFileset(String the current type. currentType, DirectoryScanner the directory scanner. ds, File the dir base base) log a message for skipping a fileset.
private String[]	restrict(String[] s, File baseDir)
protected void	runExec(Execute the Execute instance representing the external process. exe) Overrides org.apache.tools.ant.taskdefs.ExecTask.runExec. Run the specified Execute object.
protected void	runParallel(Execute the Executable to use. exe, Vector<String> the Vector of filenames. fileNames, Vector<File> the Vector of base directories corresponding to fileNames. baseDirs) Run the command in "parallel" mode, making sure that at most maxParallel sourcefiles get passed on the command line.
public void	setAddsourcefile(boolean whether to add the source file to the command line. b) Set whether to send the source file name on the command line.
public void	setDest(File the File object representing the destination directory. destDir) Specify the directory where target files are to be placed.
public void	setForce(boolean whether to bypass timestamp comparisons. b) Set whether to bypass timestamp comparisons for target files.
public void	setForwardslash(boolean whether the forward slash will be forced. forwardSlash) Set whether the source and target file names on Windows and OS/2 must use the forward slash as file separator.
public void	setIgnoremissing(boolean whether to ignore missing files. b) Set whether to ignore nonexistent files from filelists.
public void	setMaxParallel(int `int` maximum number of sourcefiles passed to the executable. max) Limit the command line length by passing at maximum this many sourcefiles at once to the command.
public void	setParallel(boolean whether to run in parallel. parallel) Set whether to execute in parallel mode.
public void	setRelative(boolean whether to pass relative pathnames. relative) Set whether the filenames should be passed on the command line as absolute or relative pathnames.
public void	setSkipEmptyFilesets(boolean whether to skip empty filesets. skip) Set whether empty filesets will be skipped.
public void	setType(ExecuteOn.FileDirBoth a FileDirBoth EnumeratedAttribute. type) Set whether the command works only on files, directories or both.
protected void	setupRedirector() Overrides org.apache.tools.ant.taskdefs.ExecTask.setupRedirector. Set up the I/O Redirector.
public void	setVerbose(boolean whether to operate in verbose mode. b) Set whether to operate in verbose mode.

addSourceFile	back to summary
private boolean addSourceFile

destDir	back to summary
protected File destDir

filesets	back to summary
protected Vector<AbstractFileSet> filesets

force	back to summary
private boolean force

forwardSlash	back to summary
private boolean forwardSlash

ignoreMissing	back to summary
private boolean ignoreMissing

mapper	back to summary
protected FileNameMapper mapper

mapperElement	back to summary
protected Mapper mapperElement

maxParallel	back to summary
private int maxParallel

parallel	back to summary
private boolean parallel

relative	back to summary
private boolean relative

resources	back to summary
private Union resources

skipEmpty	back to summary
private boolean skipEmpty

srcFilePos	back to summary
protected Commandline.Marker srcFilePos

srcIsFirst	back to summary
protected boolean srcIsFirst Has <srcfile> been specified before <targetfile>

targetFilePos	back to summary
protected Commandline.Marker targetFilePos

type	back to summary
protected String type

verbose	back to summary
private boolean verbose

ExecuteOn	back to summary
public ExecuteOn()

Method Detail

add	back to summary
public void add(ResourceCollection rc) Add a collection of resources upon which to operate. Parameters rc:ResourceCollection resource collection to add. Since Ant 1.7

add

back to summary

public void add(ResourceCollection rc)

Add a collection of resources upon which to operate.

Parameters

rc:ResourceCollection: resource collection to add.

Since

Ant 1.7

add	back to summary
public void add(FileNameMapper fileNameMapper) Add a nested FileNameMapper. Parameters fileNameMapper:FileNameMapper the mapper to add. Since Ant 1.6.3

add

back to summary

public void add(FileNameMapper fileNameMapper)

Add a nested FileNameMapper.

Parameters

fileNameMapper:FileNameMapper: the mapper to add.

Since

Ant 1.6.3

addDirset	back to summary
public void addDirset(DirSet set) Add a set of directories upon which to operate. Parameters set:DirSet the DirSet to add. Since Ant 1.6

addDirset

back to summary

public void addDirset(DirSet set)

Add a set of directories upon which to operate.

Parameters

set:DirSet: the DirSet to add.

Since

Ant 1.6

addFilelist	back to summary
public void addFilelist(FileList list) Add a list of source files upon which to operate. Parameters list:FileList the FileList to add.

addFilelist

back to summary

public void addFilelist(FileList list)

Add a list of source files upon which to operate.

Parameters

list:FileList: the FileList to add.

addFileset	back to summary
public void addFileset(FileSet set) Add a set of files upon which to operate. Parameters set:FileSet the FileSet to add.

addFileset

back to summary

public void addFileset(FileSet set)

Add a set of files upon which to operate.

Parameters

set:FileSet: the FileSet to add.

checkConfiguration	back to summary
protected void checkConfiguration() Overrides org.apache.tools.ant.taskdefs.ExecTask.checkConfiguration. Check the configuration of this ExecuteOn instance. Annotations @Override

checkConfiguration

back to summary

protected void checkConfiguration()

Overrides org.apache.tools.ant.taskdefs.ExecTask.checkConfiguration.

Check the configuration of this ExecuteOn instance.

Annotations

@Override

createHandler back to summary

createHandler	back to summary
protected ExecuteStreamHandler createHandler() throws BuildException Overrides org.apache.tools.ant.taskdefs.ExecTask.createHandler. Create the ExecuteStreamHandler instance that will be used during execution. Returns:ExecuteStreamHandler `ExecuteStreamHandler`. Annotations @Override Exceptions BuildException: on error.

protected ExecuteStreamHandler createHandler() throws BuildException

Overrides org.apache.tools.ant.taskdefs.ExecTask.createHandler.

Create the ExecuteStreamHandler instance that will be used during execution.

Returns:ExecuteStreamHandler

ExecuteStreamHandler.

Annotations

@Override

Exceptions

BuildException:: on error.

createMapper back to summary

createMapper	back to summary
public Mapper createMapper() throws BuildException Create a nested Mapper element to use for mapping source files to target files. Returns:Mapper `Mapper`. Exceptions BuildException: if more than one mapper is defined.

public Mapper createMapper() throws BuildException

Create a nested Mapper element to use for mapping source files to target files.

Returns:Mapper

Mapper.

Exceptions

BuildException:: if more than one mapper is defined.

createSrcfile back to summary

createSrcfile	back to summary
public Commandline.Marker createSrcfile() Create a placeholder indicating where on the command line the name of the source file should be inserted. Returns:Commandline.Marker `Commandline.Marker`.

public Commandline.Marker createSrcfile()

Create a placeholder indicating where on the command line the name of the source file should be inserted.

Returns:Commandline.Marker: Commandline.Marker.

createTargetfile back to summary

createTargetfile	back to summary
public Commandline.Marker createTargetfile() Create a placeholder indicating where on the command line the name of the target file should be inserted. Returns:Commandline.Marker `Commandline.Marker`.

public Commandline.Marker createTargetfile()

Create a placeholder indicating where on the command line the name of the target file should be inserted.

Returns:Commandline.Marker: Commandline.Marker.

getCommandline	back to summary
protected String[] getCommandline(String[] srcFiles, File[] baseDirs) Construct the command line for parallel execution. Parameters srcFiles:String[] The filenames to add to the commandline. baseDirs:File[] filenames are relative to this dir. Returns:String[] the command line in the form of a String[].

getCommandline

back to summary

protected String[] getCommandline(String[] srcFiles, File[] baseDirs)

Construct the command line for parallel execution.

Parameters

srcFiles:String[]: The filenames to add to the commandline.
baseDirs:File[]: filenames are relative to this dir.

Returns:String[]

the command line in the form of a String[].

getCommandline	back to summary
protected String[] getCommandline(String srcFile, File baseDir) Construct the command line for serial execution. Parameters srcFile:String The filename to add to the commandline. baseDir:File filename is relative to this dir. Returns:String[] the command line in the form of a String[].

getCommandline

back to summary

protected String[] getCommandline(String srcFile, File baseDir)

Construct the command line for serial execution.

Parameters

srcFile:String: The filename to add to the commandline.
baseDir:File: filename is relative to this dir.

Returns:String[]

the command line in the form of a String[].

getDirs	back to summary
protected String[] getDirs(File baseDir, DirectoryScanner ds) Return the list of Directories from this DirectoryScanner that should be included on the command line. Parameters baseDir:File the File base directory. ds:DirectoryScanner the DirectoryScanner to use for file scanning. Returns:String[] a String[] containing the directory names.

getDirs

back to summary

protected String[] getDirs(File baseDir, DirectoryScanner ds)

Return the list of Directories from this DirectoryScanner that should be included on the command line.

Parameters

baseDir:File: the File base directory.
ds:DirectoryScanner: the DirectoryScanner to use for file scanning.

Returns:String[]

a String[] containing the directory names.

getFiles	back to summary
protected String[] getFiles(File baseDir, DirectoryScanner ds) Return the list of files from this DirectoryScanner that should be included on the command line. Parameters baseDir:File the File base directory. ds:DirectoryScanner the DirectoryScanner to use for file scanning. Returns:String[] a String[] containing the filenames.

getFiles

back to summary

protected String[] getFiles(File baseDir, DirectoryScanner ds)

Return the list of files from this DirectoryScanner that should be included on the command line.

Parameters

baseDir:File: the File base directory.
ds:DirectoryScanner: the DirectoryScanner to use for file scanning.

Returns:String[]

a String[] containing the filenames.

getFilesAndDirs	back to summary
protected String[] getFilesAndDirs(FileList list) Return the list of files or directories from this FileList that should be included on the command line. Parameters list:FileList the FileList to check. Returns:String[] a String[] containing the directory names. Since Ant 1.6.2

getFilesAndDirs

back to summary

protected String[] getFilesAndDirs(FileList list)

Return the list of files or directories from this FileList that should be included on the command line.

Parameters

list:FileList: the FileList to check.

Returns:String[]

a String[] containing the directory names.

Since

Ant 1.6.2

insertTargetFiles	back to summary
private static void insertTargetFiles(String[] targetFiles, String[] arguments, int insertPosition, String prefix, String suffix) Inserts target file names (which are already absolute paths) into the list of arguments, taking prefix and postfix into account.

logSkippingFileset	back to summary
private void logSkippingFileset(String currentType, DirectoryScanner ds, File base) log a message for skipping a fileset. Parameters currentType:String the current type. ds:DirectoryScanner the directory scanner. base:File the dir base

logSkippingFileset

back to summary

private void logSkippingFileset(String currentType, DirectoryScanner ds, File base)

log a message for skipping a fileset.

Parameters

currentType:String: the current type.
ds:DirectoryScanner: the directory scanner.
base:File: the dir base

restrict	back to summary
private String[] restrict(String[] s, File baseDir)

runExec	back to summary
protected void runExec(Execute exe) throws BuildException Overrides org.apache.tools.ant.taskdefs.ExecTask.runExec. Run the specified Execute object. Parameters exe:Execute the Execute instance representing the external process. Annotations @Override Exceptions BuildException: on error

runExec

back to summary

protected void runExec(Execute exe) throws BuildException

Overrides org.apache.tools.ant.taskdefs.ExecTask.runExec.

Run the specified Execute object.

Parameters

exe:Execute: the Execute instance representing the external process.

Annotations

@Override

Exceptions

BuildException:: on error

runParallel	back to summary
protected void runParallel(Execute exe, Vector<String> fileNames, Vector<File> baseDirs) throws IOException, BuildException Run the command in "parallel" mode, making sure that at most maxParallel sourcefiles get passed on the command line. Parameters exe:Execute the Executable to use. fileNames:Vector<String> the Vector of filenames. baseDirs:Vector<File> the Vector of base directories corresponding to fileNames. Exceptions IOException: on I/O errors. BuildException: on other errors. Since Ant 1.6

runParallel

back to summary

protected void runParallel(Execute exe, Vector<String> fileNames, Vector<File> baseDirs) throws IOException, BuildException

Run the command in "parallel" mode, making sure that at most maxParallel sourcefiles get passed on the command line.

Parameters

exe:Execute: the Executable to use.
fileNames:Vector<String>: the Vector of filenames.
baseDirs:Vector<File>: the Vector of base directories corresponding to fileNames.

Exceptions

IOException:: on I/O errors.
BuildException:: on other errors.

Since

Ant 1.6

setAddsourcefile back to summary

setAddsourcefile	back to summary
public void setAddsourcefile(boolean b) Set whether to send the source file name on the command line. Defaults to `true`. Parameters b:boolean whether to add the source file to the command line. Since Ant 1.6

public void setAddsourcefile(boolean b)

Set whether to send the source file name on the command line.

Defaults to true.

Parameters

b:boolean: whether to add the source file to the command line.

Since

Ant 1.6

setDest	back to summary
public void setDest(File destDir) Specify the directory where target files are to be placed. Parameters destDir:File the File object representing the destination directory.

setDest

back to summary

public void setDest(File destDir)

Specify the directory where target files are to be placed.

Parameters

destDir:File: the File object representing the destination directory.

setForce	back to summary
public void setForce(boolean b) Set whether to bypass timestamp comparisons for target files. Parameters b:boolean whether to bypass timestamp comparisons. Since Ant 1.6.3

setForce

back to summary

public void setForce(boolean b)

Set whether to bypass timestamp comparisons for target files.

Parameters

b:boolean: whether to bypass timestamp comparisons.

Since

Ant 1.6.3

setForwardslash	back to summary
public 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. Parameters forwardSlash:boolean whether the forward slash will be forced.

setForwardslash

back to summary

public 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.

Parameters

forwardSlash:boolean: whether the forward slash will be forced.

setIgnoremissing	back to summary
public void setIgnoremissing(boolean b) Set whether to ignore nonexistent files from filelists. Parameters b:boolean whether to ignore missing files. Since Ant 1.6.2

setIgnoremissing

back to summary

public void setIgnoremissing(boolean b)

Set whether to ignore nonexistent files from filelists.

Parameters

b:boolean: whether to ignore missing files.

Since

Ant 1.6.2

setMaxParallel back to summary

setMaxParallel	back to summary
public void setMaxParallel(int max) Limit the command line length by passing at maximum this many sourcefiles at once to the command. Set to <= 0 for unlimited - this is the default. Parameters max:int `int` maximum number of sourcefiles passed to the executable. Since Ant 1.6

public void setMaxParallel(int max)

Limit the command line length by passing at maximum this many sourcefiles at once to the command.

Set to <= 0 for unlimited - this is the default.

Parameters

max:int: int maximum number of sourcefiles passed to the executable.

Since

Ant 1.6

setParallel	back to summary
public void setParallel(boolean parallel) Set whether to execute in parallel mode. If true, run the command only once, appending all files as arguments. If false, command will be executed once for every file. Defaults to false. Parameters parallel:boolean whether to run in parallel.

setParallel

back to summary

public void setParallel(boolean parallel)

Set whether to execute in parallel mode. If true, run the command only once, appending all files as arguments. If false, command will be executed once for every file. Defaults to false.

Parameters

parallel:boolean: whether to run in parallel.

setRelative

back to summary

public void setRelative(boolean relative)

Set whether the filenames should be passed on the command line as absolute or relative pathnames. Paths are relative to the base directory of the corresponding fileset for source files or the dest attribute for target files.

Parameters

relative:boolean: whether to pass relative pathnames.

setSkipEmptyFilesets

back to summary

public void setSkipEmptyFilesets(boolean skip)

Set whether empty filesets will be skipped. If true and no source files have been found or are newer than their corresponding target files, the command will not be run.

Parameters

skip:boolean: whether to skip empty filesets.

setType

back to summary

public void setType(ExecuteOn.FileDirBoth type)

Set whether the command works only on files, directories or both.

Parameters

type:ExecuteOn.FileDirBoth: a FileDirBoth EnumeratedAttribute.

setupRedirector

back to summary

protected void setupRedirector()

Overrides org.apache.tools.ant.taskdefs.ExecTask.setupRedirector.

Set up the I/O Redirector.

Annotations

@Override

setVerbose

back to summary

public void setVerbose(boolean b)

Set whether to operate in verbose mode. If true, a verbose summary will be printed after execution.

Parameters

b:boolean: whether to operate in verbose mode.

Since

Ant 1.6

Modifier and Type	Field and Description
public static final String	DIR Dir value
public static final String	FILE File value

public Class ExecuteOn

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ExecuteOn.FileDirBoth

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail