org.apache.tools.ant.types

Class CommandlineJava

public class CommandlineJava extends Object implements Cloneable

A representation of a Java command line that is a composite of 2 Commandlines. One is used for the vm/options and one for the classname/arguments. It provides specific methods for a Java command line.
Nested Class Summary
static classCommandlineJava.SysProperties
Specialized Environment class for System properties.
Constructor Summary
CommandlineJava()
Constructor uses the VM we are running on now.
Method Summary
voidaddSysproperties(CommandlineJava.SysProperties sysp)
Add a set of system properties.
voidaddSysproperty(Environment.Variable sysp)
Add a system property.
voidaddSyspropertyset(PropertySet sysp)
Add a set of system properties.
voidclearJavaArgs()
Clear out the java arguments.
Objectclone()
Deep clone the object.
Commandline.ArgumentcreateArgument()
Create a new argument to the java program.
PathcreateBootclasspath(Project p)
Create a boot classpath.
PathcreateClasspath(Project p)
Create a classpath.
Commandline.ArgumentcreateVmArgument()
Create a new JVM argument.
StringdescribeCommand()
Return a String that describes the command and arguments suitable for verbose output before a call to Runtime.exec(String[]).
StringdescribeJavaCommand()
Return a String that describes the java command and arguments for in-VM executions.
protected CommandlinegetActualVMCommand()
Get the VM command parameters, including memory settings.
AssertionsgetAssertions()
Get the current assertions.
PathgetBootclasspath()
Get the boot classpath.
StringgetClassname()
Get the name of the class to be run.
PathgetClasspath()
Get the classpath for the command.
String[]getCommandline()
Get the command line to run a Java vm.
StringgetJar()
Get the name of the jar to be run.
CommandlinegetJavaCommand()
Get the Java command to be used.
CommandlineJava.SysPropertiesgetSystemProperties()
Get the system properties object.
CommandlinegetVmCommand()
Get the VM command, including memory.
StringgetVmversion()
Get the vm version.
protected booleanhaveBootclasspath(boolean log)
Determine whether the bootclasspath has been specified, and whether it shall really be used (build.sysclasspath could be set or the VM may not support it).
protected booleanhaveClasspath()
Determine whether the classpath has been specified, and whether it shall really be used or be nulled by build.sysclasspath.
voidrestoreSystemProperties()
Restore the cached system properties.
voidsetAssertions(Assertions assertions)
Add an assertion set to the command.
voidsetClassname(String classname)
Set the classname to execute.
voidsetCloneVm(boolean cloneVm)
Set whether system properties will be copied to the cloned VM--as well as the bootclasspath unless you have explicitly specified a bootclasspath.
voidsetJar(String jarpathname)
Set a jar file to execute via the -jar option.
voidsetMaxmemory(String max)
Specify max memory of the JVM.
voidsetSystemProperties()
Cache current system properties and set them to those in this Java command.
voidsetVm(String vm)
Set the executable used to start the new JVM.
voidsetVmversion(String value)
Set the JVM version required.
intsize()
Get the size of the java command line.
StringtoString()
Get a string description.

Constructor Detail

CommandlineJava

public CommandlineJava()
Constructor uses the VM we are running on now.

Method Detail

addSysproperties

public void addSysproperties(CommandlineJava.SysProperties sysp)
Add a set of system properties.

Parameters: sysp a set of properties.

Since: Ant 1.6.3

addSysproperty

public void addSysproperty(Environment.Variable sysp)
Add a system property.

Parameters: sysp a property to be set in the JVM.

addSyspropertyset

public void addSyspropertyset(PropertySet sysp)
Add a set of system properties.

Parameters: sysp a set of properties.

clearJavaArgs

public void clearJavaArgs()
Clear out the java arguments.

clone

public Object clone()
Deep clone the object.

Returns: a CommandlineJava object.

Throws: BuildException if anything went wrong. CloneNotSupportedException never.

createArgument

public Commandline.Argument createArgument()
Create a new argument to the java program.

Returns: an argument to be configured.

createBootclasspath

public Path createBootclasspath(Project p)
Create a boot classpath.

Parameters: p the project to use to create the path.

Returns: a path to be configured.

Since: Ant 1.6

createClasspath

public Path createClasspath(Project p)
Create a classpath.

Parameters: p the project to use to create the path.

Returns: a path to be configured.

createVmArgument

public Commandline.Argument createVmArgument()
Create a new JVM argument.

Returns: an argument to be configured.

describeCommand

public String describeCommand()
Return a String that describes the command and arguments suitable for verbose output before a call to Runtime.exec(String[]).

Returns: the description string.

Since: Ant 1.5

describeJavaCommand

public String describeJavaCommand()
Return a String that describes the java command and arguments for in-VM executions.

The class name is the executable in this context.

Returns: the description string.

Since: Ant 1.5

getActualVMCommand

protected Commandline getActualVMCommand()
Get the VM command parameters, including memory settings.

Returns: the VM command parameters.

getAssertions

public Assertions getAssertions()
Get the current assertions.

Returns: assertions or null.

getBootclasspath

public Path getBootclasspath()
Get the boot classpath.

Returns: boot classpath or null.

getClassname

public String getClassname()
Get the name of the class to be run.

Returns: the name of the class to run or null if there is no class.

See Also: getJar

getClasspath

public Path getClasspath()
Get the classpath for the command.

Returns: the classpath or null.

getCommandline

public String[] getCommandline()
Get the command line to run a Java vm.

Returns: the list of all arguments necessary to run the vm.

getJar

public String getJar()
Get the name of the jar to be run.

Returns: the pathname of the jar file to run via -jar option or null if there is no jar to run.

See Also: getClassname

getJavaCommand

public Commandline getJavaCommand()
Get the Java command to be used.

Returns: the java command--not a clone.

getSystemProperties

public CommandlineJava.SysProperties getSystemProperties()
Get the system properties object.

Returns: The system properties object.

getVmCommand

public Commandline getVmCommand()
Get the VM command, including memory.

Returns: A deep clone of the instance's VM command, with memory settings added.

getVmversion

public String getVmversion()
Get the vm version.

Returns: the vm version.

haveBootclasspath

protected boolean haveBootclasspath(boolean log)
Determine whether the bootclasspath has been specified, and whether it shall really be used (build.sysclasspath could be set or the VM may not support it).

Parameters: log whether to log a warning if a bootclasspath has been specified but will be ignored.

Returns: true if the bootclasspath is to be used.

Since: Ant 1.6

haveClasspath

protected boolean haveClasspath()
Determine whether the classpath has been specified, and whether it shall really be used or be nulled by build.sysclasspath.

Returns: true if the classpath is to be used.

Since: Ant 1.6

restoreSystemProperties

public void restoreSystemProperties()
Restore the cached system properties.

Throws: BuildException if Security prevented this operation, or there was no system properties to restore

setAssertions

public void setAssertions(Assertions assertions)
Add an assertion set to the command.

Parameters: assertions assertions to make.

setClassname

public void setClassname(String classname)
Set the classname to execute.

Parameters: classname the fully qualified classname.

setCloneVm

public void setCloneVm(boolean cloneVm)
Set whether system properties will be copied to the cloned VM--as well as the bootclasspath unless you have explicitly specified a bootclasspath.

Parameters: cloneVm if true copy the system properties.

Since: Ant 1.7

setJar

public void setJar(String jarpathname)
Set a jar file to execute via the -jar option.

Parameters: jarpathname the pathname of the jar to execute.

setMaxmemory

public void setMaxmemory(String max)
Specify max memory of the JVM. -mx or -Xmx depending on VM version.

Parameters: max the string to pass to the jvm to specifiy the max memory.

setSystemProperties

public void setSystemProperties()
Cache current system properties and set them to those in this Java command.

Throws: BuildException if Security prevented this operation.

setVm

public void setVm(String vm)
Set the executable used to start the new JVM.

Parameters: vm the executable to use.

setVmversion

public void setVmversion(String value)
Set the JVM version required.

Parameters: value the version required.

size

public int size()

Deprecated: since 1.7. Please dont use this, it effectively creates the entire command.

Get the size of the java command line. This is a fairly intensive operation, as it has to evaluate the size of many components.

Returns: the total number of arguments in the java command line.

See Also: getCommandline

toString

public String toString()
Get a string description.

Returns: the command line as a string.