org.codehaus.plexus.util.cli
public abstract class CommandLineUtils extends Object
Version: $Id: CommandLineUtils.java 8700 2010-04-24 12:03:28Z bentmann $
Nested Class Summary | |
---|---|
static class | CommandLineUtils.StringStreamConsumer |
Method Summary | |
---|---|
static void | addShutdownHook() |
static int | executeCommandLine(Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr) |
static int | executeCommandLine(Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) |
static int | executeCommandLine(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr) |
static int | executeCommandLine(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) |
static Properties | getSystemEnvVars()
Gets the shell environment variables for this process. |
static Properties | getSystemEnvVars(boolean caseSensitive)
Return the shell environment variables. |
static boolean | isAlive(long pid) |
static boolean | isAlive(Process p) |
static void | killProcess(long pid)
Kill a process launched by executeCommandLine methods.
|
static String | quote(String argument) Put quotes around the given String if necessary. If the argument doesn't include spaces or quotes, return it as is. |
static String | quote(String argument, boolean wrapExistingQuotes) Put quotes around the given String if necessary. If the argument doesn't include spaces or quotes, return it as is. |
static String | quote(String argument, boolean escapeSingleQuotes, boolean escapeDoubleQuotes, boolean wrapExistingQuotes) |
static void | removeShutdownHook(boolean execute) |
static String | toString(String[] line) |
static String[] | translateCommandline(String toProcess) |
Parameters: cl The command line to execute systemIn The input to read from, must be thread safe systemOut A consumer that receives output, must be thread safe systemErr A consumer that receives system error stream output, must be thread safe timeoutInSeconds Positive integer to specify timeout, zero and negative integers for no timeout.
Returns: A return value, see Process#exitValue()
Throws: CommandLineException or CommandLineTimeOutException if time out occurs
getSystemEnvVars().get("path")
and getSystemEnvVars().get("PATH")
will in general return different values. However, on platforms
with case-insensitive environment variables like Windows, all variable names will be normalized to upper case.
Returns: The shell environment variables, can be empty but never null
.
Throws: IOException If the environment variables could not be queried from the shell.
See Also: System#getenv() System.getenv() API, new in JDK 5.0, to get the same result
since 2.0.2 System#getenv() will be used if available in the current running jvm.
caseSensitive == true
, then envar
keys will all be upper-case.
Parameters: caseSensitive Whether environment variable keys should be treated case-sensitively.
Returns: Properties object of (possibly modified) envar keys mapped to their values.
Throws: IOException
See Also: System#getenv() System.getenv() API, new in JDK 5.0, to get the same result
since 2.0.2 System#getenv() will be used if available in the current running jvm.
Parameters: pid The pid of command return by Commandline.getPid()
Deprecated: Use (String, char, char[], char[], char, boolean)
,
(String, char, char[], char, boolean)
, or
StringUtils instead.
Put quotes around the given String if necessary.
If the argument doesn't include spaces or quotes, return it as is. If it contains double quotes, use single quotes - else surround the argument by double quotes.
Throws: CommandLineException if the argument contains both, single and double quotes.
Deprecated: Use (String, char, char[], char[], char, boolean)
,
(String, char, char[], char, boolean)
, or
StringUtils instead.
Put quotes around the given String if necessary.
If the argument doesn't include spaces or quotes, return it as is. If it contains double quotes, use single quotes - else surround the argument by double quotes.
Throws: CommandLineException if the argument contains both, single and double quotes.
Deprecated: Use (String, char, char[], char[], char, boolean)
,
(String, char, char[], char, boolean)
, or
StringUtils instead.