org.apache.commons.launcher

Class LaunchCommand

public class LaunchCommand extends Object

A class that represents the holds the various argument types that are used in a Java command. In addition, it holds many of the flags that are used by the {@link LaunchTask} class when executing a JVM process.

Author: Patrick Luby

Method Summary
booleangetAppendoutput()
Get the appendOutput flag.
ArrayListgetArgs()
Get the list of nested arg elements.
StringgetClassname()
Get the class name.
StringgetClasspath()
Get the classpath.
booleangetDebug()
Get the debug flag.
booleangetDisplayminimizedwindow()
Get the displayMinimizedWindow flag.
booleangetDisposeminimizedwindow()
Get the disposeMinimizedWindow flag.
booleangetFailonerror()
Get the failOnError flag.
ArrayListgetJvmargs()
Get the list of nested jvmarg elements.
FilegetMinimizedwindowicon()
Get the icon file for the minimized window that will be displayed in the Windows taskbar.
StringgetMinimizedwindowtitle()
Get the title for the minimized window that will be displayed in the Windows taskbar.
FilegetOutput()
Get the file that the child JVM's System.out and System.err will be redirected to.
booleangetPrint()
Get the print flag.
booleangetRedirectoutput()
Get the redirect flag.
booleangetRequiretools()
Get the requireTools flag.
HashMapgetSysproperties()
Get the list of nested sysproperty elements.
booleangetUsesystemin()
Get the useSystemIn flag.
booleangetWaitforchild()
Get the waitForChild flag.
voidsetAppendoutput(boolean appendOutput)
Set the appendOutput flag.
voidsetArgs(ArrayList args)
Set the list of nested arg elements.
voidsetClassname(String mainClassName)
Set the class name.
voidsetClasspath(String classpath)
Set the classpath.
voidsetDebug(boolean debug)
Set the debug flag.
voidsetDisplayminimizedwindow(boolean displayMinimizedWindow)
Set the displayMinimizedWindow flag.
voidsetDisposeminimizedwindow(boolean disposeMinimizedWindow)
Set the disposeMinimizedWindow flag.
voidsetFailonerror(boolean failOnError)
Set the failOnError flag.
voidsetJvmargs(ArrayList jvmArgs)
Set the list of nested jvmarg elements.
voidsetMinimizedwindowicon(File minimizedWindowIcon)
Set the icon file for the minimized window that will be displayed in the Windows taskbar.
voidsetMinimizedwindowtitle(String minimizedWindowTitle)
Set the title for the minimized window that will be displayed in the Windows taskbar.
voidsetOutput(File outputFile)
Set the file that the child JVM's System.out and System.err will be redirected to.
voidsetPrint(boolean print)
Set the print flag.
voidsetRedirectoutput(boolean redirect)
Set the redirect flag.
voidsetRequiretools(boolean requireTools)
Set the requireTools flag.
voidsetSysproperties(HashMap sysProperties)
Set the list of nested sysproperty elements.
voidsetUsesystemin(boolean useSystemIn)
Set the useSystemIn flag.
voidsetWaitforchild(boolean waitForChild)
Set the waitForChild flag.

Method Detail

getAppendoutput

public boolean getAppendoutput()
Get the appendOutput flag.

Returns: the appendOutput flag

getArgs

public ArrayList getArgs()
Get the list of nested arg elements.

Returns: the list of {@link String} objects

getClassname

public String getClassname()
Get the class name.

Returns: the class to execute main(String[])

getClasspath

public String getClasspath()
Get the classpath.

Returns: the classpath

getDebug

public boolean getDebug()
Get the debug flag.

Returns: the debug flag

getDisplayminimizedwindow

public boolean getDisplayminimizedwindow()
Get the displayMinimizedWindow flag.

Returns: the displayMinimizedWindow flag

getDisposeminimizedwindow

public boolean getDisposeminimizedwindow()
Get the disposeMinimizedWindow flag.

Returns: the disposeMinimizedWindow flag

getFailonerror

public boolean getFailonerror()
Get the failOnError flag.

Returns: the failOnError flag

getJvmargs

public ArrayList getJvmargs()
Get the list of nested jvmarg elements.

Returns: the list of {@link String} objects

getMinimizedwindowicon

public File getMinimizedwindowicon()
Get the icon file for the minimized window that will be displayed in the Windows taskbar.

Returns: the icon file to use for any minimized window that is displayed in the Windows taskbar

getMinimizedwindowtitle

public String getMinimizedwindowtitle()
Get the title for the minimized window that will be displayed in the Windows taskbar.

Returns: the title to set for any minimized window that is displayed in the Windows taskbar

getOutput

public File getOutput()
Get the file that the child JVM's System.out and System.err will be redirected to.

Returns: the File to redirect System.out and System.err to

getPrint

public boolean getPrint()
Get the print flag.

Returns: the print flag

getRedirectoutput

public boolean getRedirectoutput()
Get the redirect flag.

Returns: the redirect flag

getRequiretools

public boolean getRequiretools()
Get the requireTools flag.

Returns: the requireTools flag

getSysproperties

public HashMap getSysproperties()
Get the list of nested sysproperty elements.

Returns: the {@link String} objects

getUsesystemin

public boolean getUsesystemin()
Get the useSystemIn flag.

Returns: the useSystemIn flag

getWaitforchild

public boolean getWaitforchild()
Get the waitForChild flag.

Returns: the waitForChild flag

setAppendoutput

public void setAppendoutput(boolean appendOutput)
Set the appendOutput flag. Setting this flag to true will cause the child JVM to append System.out and System.err to the file specified by the {@link #setOutput(File)} method. Setting this flag to false will cause the child to overwrite the file.

Parameters: appendOutput true if output should be appended to the output file

setArgs

public void setArgs(ArrayList args)
Set the list of nested arg elements.

Parameters: args a list of {@link String} objects

setClassname

public void setClassname(String mainClassName)
Set the class name.

Parameters: mainClassName the class to execute main(String[])

setClasspath

public void setClasspath(String classpath)
Set the classpath.

Parameters: classpath the classpath

setDebug

public void setDebug(boolean debug)
Set the debug flag.

Parameters: debug the debug flag

setDisplayminimizedwindow

public void setDisplayminimizedwindow(boolean displayMinimizedWindow)
Set the displayMinimizedWindow flag. Note that this flag has no effect on non-Windows platforms. On Windows platform, setting this flag to true will cause a minimized window to be displayed in the Windows task bar while the child process is executing. This flag is usually set to true for server applications that also have their "waitForChild" attribute set to false via the {@link #setWaitforchild(boolean)} method.

Parameters: displayMinimizedWindow true if a minimized window should be displayed in the Windows task bar while the child process is executing

setDisposeminimizedwindow

public void setDisposeminimizedwindow(boolean disposeMinimizedWindow)
Set the disposeMinimizedWindow flag. Note that this flag has no effect on non-Windows platforms. On Windows platform, setting this flag to true will cause any minimized window that is display by setting the "displayMinimizedWindow" attribute to true via the {@link #setDisplayminimizedwindow(boolean)} to be automatically disposed of when the child JVM's main(String[]) returns. This flag is normally used for applications that don't explicitly call {@link System#exit(int)}. If an application does not explicitly call {@link System#exit(int)}, an minimized windows need to be disposed of for the child JVM to exit.

Parameters: disposeMinimizedWindow true if a minimized window in the Windows taskbar should be automatically disposed of after the child JVM's main(String[]) returns

setFailonerror

public void setFailonerror(boolean failOnError)
Set the failOnError flag.

Parameters: failOnError the failOnError flag

setJvmargs

public void setJvmargs(ArrayList jvmArgs)
Set the list of nested jvmarg elements.

Parameters: jvmArgs a list of {@link String} objects

setMinimizedwindowicon

public void setMinimizedwindowicon(File minimizedWindowIcon)
Set the icon file for the minimized window that will be displayed in the Windows taskbar. Note that this property has no effect on non-Windows platforms.

Parameters: minimizedWindowIcon the icon file to use for any minimized window that is displayed in the Windows taskbar

setMinimizedwindowtitle

public void setMinimizedwindowtitle(String minimizedWindowTitle)
Set the title for the minimized window that will be displayed in the Windows taskbar. Note that this property has no effect on non-Windows platforms.

Parameters: minimizedWindowTitle the title to set for any minimized window that is displayed in the Windows taskbar

setOutput

public void setOutput(File outputFile)
Set the file that the child JVM's System.out and System.err will be redirected to. Output will only be redirected if the redirect flag is set to true via the {@link #setRedirectoutput(boolean)} method.

Parameters: outputFile a File to redirect System.out and System.err to

setPrint

public void setPrint(boolean print)
Set the print flag.

Parameters: print the print flag

setRedirectoutput

public void setRedirectoutput(boolean redirect)
Set the redirect flag. Setting this flag to true will cause the child JVM's System.out and System.err to be redirected to file set using the {@link #setOutput(File)} method. Setting this flag to false will cause no redirection.

Parameters: redirect true if System.out and System.err should be redirected

setRequiretools

public void setRequiretools(boolean requireTools)
Set the requireTools flag.

Parameters: requireTools the requireTools flag

setSysproperties

public void setSysproperties(HashMap sysProperties)
Set the list of nested sysproperty elements.

Parameters: sysProperties a map of {@link String} objects

setUsesystemin

public void setUsesystemin(boolean useSystemIn)
Set the useSystemIn flag. Setting this flag to false will cause this task to not read System.in. This will cause the child JVM to never receive any bytes when it reads System.in. Setting this flag to false is useful in some Unix environments where processes cannot be put in the background when they read System.in.

Parameters: useSystemIn the useSystemIn flag

setWaitforchild

public void setWaitforchild(boolean waitForChild)
Set the waitForChild flag. Setting this flag to true will cause this task to wait for the child JVM to finish executing before the task completes. Setting this flag to false will cause this task to complete immediately after it starts the execution of the child JVM. Setting it false emulates the "&" background operator in most Unix shells and is most of set to false when launching server or GUI applications.

Parameters: waitForChild the waitForChild flag

Copyright (c) 2001-2002 - Apache Software Foundation