Launcher for Java applications. Allows use of
the same JVM for the called application thus resulting in much
faster operation.
addAssertions
public void addAssertions(Assertions asserts)
assertions to enable in this program (if fork=true)
asserts
- assertion set
- Ant 1.6
addConfiguredRedirector
public void addConfiguredRedirector(RedirectorElement redirectorElement)
Add a RedirectorElement
to this task.
redirectorElement
- RedirectorElement
.
addEnv
public void addEnv(Environment.Variable var)
Adds an environment variable.
Will be ignored if we are not forking a new VM.
var
- new environment variable
- Ant 1.5
addSysproperty
public void addSysproperty(Environment.Variable sysp)
Adds a system property.
sysp
- system property
addSyspropertyset
public void addSyspropertyset(PropertySet sysp)
Adds a set of properties as system properties.
sysp
- set of properties to add
- Ant 1.6
clearArgs
public void clearArgs()
Clear out the arguments to this java task.
createBootclasspath
public Path createBootclasspath()
Adds a path to the bootclasspath.
- created bootclasspath
- Ant 1.6
createClasspath
public Path createClasspath()
Adds a path to the classpath.
- created classpath
createPermissions
public Permissions createPermissions()
Sets the permissions for the application run inside the same JVM.
- .
- Ant 1.6
execute
public void execute()
throws BuildException
Do the execution.
- execute in interface Task
BuildException
- if failOnError is set to true and the application
returns a non 0 result code
executeJava
public int executeJava()
throws BuildException
Do the execution and return a return code.
- the return code from the execute java class if it was
executed in a separate VM (fork = "yes").
BuildException
- if required parameters are missing
getCommandLine
public CommandlineJava getCommandLine()
accessor to the command line
- the current command line
- 1.6.3
getSysProperties
public CommandlineJava.SysProperties getSysProperties()
get the system properties of the command line
- the current properties of this java invocation
- 1.6.3
handleErrorFlush
protected void handleErrorFlush(String output)
Handle output sent to System.err and flush the stream.
- handleErrorFlush in interface Task
output
- string of stderr
- Ant 1.5.2
handleErrorOutput
protected void handleErrorOutput(String output)
Handle output sent to System.err
- handleErrorOutput in interface Task
output
- string of stderr
- Ant 1.5
handleFlush
protected void handleFlush(String output)
Pass output sent to System.out to specified output file.
- handleFlush in interface Task
output
- string of output on its way to its handlers
- Ant 1.5.2
handleInput
public int handleInput(byte[] buffer,
int offset,
int length)
throws IOException
Handle an input request by this task
- handleInput in interface Task
buffer
- the buffer into which data is to be read.offset
- the offset into the buffer at which data is stored.length
- the amount of data to read
- the number of bytes read
- Ant 1.6
handleOutput
protected void handleOutput(String output)
Pass output sent to System.out to specified output file.
- handleOutput in interface Task
output
- a string of output on its way to the handlers
- Ant 1.5
maybeSetResultPropertyValue
protected void maybeSetResultPropertyValue(int result)
helper method to set result property to the
passed in value if appropriate
result
- the exit code
run
protected void run(String classname,
Vector args)
throws BuildException
Executes the given classname with the given arguments as it
was a command line application.
classname
- the name of the class to runargs
- arguments for the class
BuildException
- in case of IO Exception in the execution
setAppend
public void setAppend(boolean append)
If true, append output to existing file.
append
- if true, append output to existing file
- Ant 1.5
setArgs
public void setArgs(String s)
Deprecated: use nested arg instead.
Set the command line arguments for the class.
s
- arguments
setClassname
public void setClassname(String s)
throws BuildException
Sets the Java class to execute.
s
- the name of the main class
BuildException
- if the jar attribute has been set
setClasspath
public void setClasspath(Path s)
Set the classpath to be used when running the Java class
s
- an Ant Path object containing the classpath.
setClasspathRef
public void setClasspathRef(Reference r)
Classpath to use, by reference.
r
- a reference to an existing classpath
setDir
public void setDir(File d)
The working directory of the process
d
- working directory
setError
public void setError(File error)
File the error stream of the process is redirected to.
error
- file getting the error stream
- ant 1.6
setErrorProperty
public void setErrorProperty(String errorProperty)
Property name whose value should be set to the error of
the process.
errorProperty
- property name
- ant 1.6
setFailonerror
public void setFailonerror(boolean fail)
If true, then fail if the command exits with a
returncode other than 0
fail
- if true fail the build when the command exits with a non
zero returncode
setFork
public void setFork(boolean s)
If true, execute in a new VM.
s
- do you want to run Java in a new VM.
setInput
public void setInput(File input)
Set the input to use for the task
input
- name of the input file
setInputString
public void setInputString(String inputString)
Set the string to use as input
inputString
- the string which is used as the input source
setJVMVersion
public void setJVMVersion(String value)
Sets the JVM version.
value
- JVM version
setJar
public void setJar(File jarfile)
throws BuildException
The location of the JAR file to execute.
jarfile
- the jarfile that one wants to execute
BuildException
- if there is also a main class specified
setJvm
public void setJvm(String s)
Set the command used to start the VM (only if forking).
s
- command to start the VM
setJvmargs
public void setJvmargs(String s)
Set the command line arguments for the JVM.
s
- jvmargs
setLogError
public void setLogError(boolean logError)
Controls whether error output of exec is logged. This is only useful
when output is being redirected and error output is desired in the
Ant log
logError
- get in the ant log the messages coming from stderr
in the case that fork = true
setMaxmemory
public void setMaxmemory(String max)
Corresponds to -mx or -Xmx depending on VM version.
max
- max memory parameter
setNewenvironment
public void setNewenvironment(boolean newenv)
If true, use a completely new environment.
Will be ignored if we are not forking a new VM.
newenv
- if true, use a completely new environment.
- Ant 1.5
setOutput
public void setOutput(File out)
File the output of the process is redirected to.
out
- name of the output file
setOutputproperty
public void setOutputproperty(String outputProp)
Property name whose value should be set to the output of
the process.
outputProp
- property name
setResultProperty
public void setResultProperty(String resultProperty)
The name of a property in which the return code of the
command should be stored. Only of interest if failonerror=false.
resultProperty
- name of property
- Ant 1.6
setSpawn
public void setSpawn(boolean spawn)
set whether or not you want the process to be spawned
default is not spawned
spawn
- if true you do not want ant to wait for the end of the process
- ant 1.6
setTimeout
public void setTimeout(Long value)
Timeout in milliseconds after which the process will be killed.
value
- time out in milliseconds
- Ant 1.5
setupRedirector
protected void setupRedirector()
Set up properties on the redirector that we needed to store locally.