Package org.codehaus.plexus.util.cli
Class CommandLineUtils
java.lang.Object
org.codehaus.plexus.util.cli.CommandLineUtils
- Author:
- Trygve Laugstøl
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
AStreamConsumer
providing consumed lines as aString
. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic int
executeCommandLine
(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr) static int
executeCommandLine
(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) static int
executeCommandLine
(Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr) static int
executeCommandLine
(Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) static CommandLineCallable
executeCommandLineAsCallable
(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) Immediately forks a process, returns a callable that will block until process is complete.static Properties
Gets the shell environment variables for this process.static Properties
getSystemEnvVars
(boolean caseSensitive) Return the shell environment variables.static boolean
static String
Deprecated.static String
static String
quote
(String argument, boolean escapeSingleQuotes, boolean escapeDoubleQuotes, boolean wrapExistingQuotes) static String
static String[]
translateCommandline
(String toProcess)
-
Constructor Details
-
CommandLineUtils
public CommandLineUtils()
-
-
Method Details
-
executeCommandLine
public static int executeCommandLine(Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr) throws CommandLineException - Throws:
CommandLineException
-
executeCommandLine
public static int executeCommandLine(Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) throws CommandLineException - Throws:
CommandLineException
-
executeCommandLine
public static int executeCommandLine(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr) throws CommandLineException - Throws:
CommandLineException
-
executeCommandLine
public static int executeCommandLine(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) throws CommandLineException - Parameters:
cl
- The command line to executesystemIn
- The input to read from, must be thread safesystemOut
- A consumer that receives output, must be thread safesystemErr
- A consumer that receives system error stream output, must be thread safetimeoutInSeconds
- 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
-
executeCommandLineAsCallable
public static CommandLineCallable executeCommandLineAsCallable(Commandline cl, InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds) throws CommandLineException Immediately forks a process, returns a callable that will block until process is complete.- Parameters:
cl
- The command line to executesystemIn
- The input to read from, must be thread safesystemOut
- A consumer that receives output, must be thread safesystemErr
- A consumer that receives system error stream output, must be thread safetimeoutInSeconds
- Positive integer to specify timeout, zero and negative integers for no timeout.- Returns:
- A CommandLineCallable that provides the process return value, see
Process.exitValue()
. "call" must be called on this to be sure the forked process has terminated, no guarantees is made about any internal state before after the completion of the call statements - Throws:
CommandLineException
- or CommandLineTimeOutException if time out occurs
-
getSystemEnvVars
Gets the shell environment variables for this process. Note that the returned mapping from variable names to values will always be case-sensitive regardless of the platform, i.e.getSystemEnvVars().get("path")
andgetSystemEnvVars().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
. - See Also:
-
getSystemEnvVars
Return the shell environment variables. IfcaseSensitive == 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.
- See Also:
-
isAlive
-
translateCommandline
- Throws:
Exception
-
quote
Deprecated.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.
- Parameters:
argument
- the argument- Returns:
- the transformed command line
- Throws:
CommandLineException
- if the argument contains both, single and double quotes.
-
quote
@Deprecated public static String quote(String argument, boolean wrapExistingQuotes) throws CommandLineException Deprecated.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.
- Parameters:
argument
- see namewrapExistingQuotes
- see name- Returns:
- the transformed command line
- Throws:
CommandLineException
- if the argument contains both, single and double quotes.
-
quote
@Deprecated public static String quote(String argument, boolean escapeSingleQuotes, boolean escapeDoubleQuotes, boolean wrapExistingQuotes) throws CommandLineException Deprecated.- Parameters:
argument
- the argumentescapeSingleQuotes
- see nameescapeDoubleQuotes
- see namewrapExistingQuotes
- see name- Returns:
- the transformed command line
- Throws:
CommandLineException
- some trouble
-
toString
-
StringUtils.quoteAndEscape(String, char, char[], char[], char, boolean)
,StringUtils.quoteAndEscape(String, char, char[], char, boolean)
, orStringUtils.quoteAndEscape(String, char)
instead.