Package org.codehaus.plexus.util.cli
Class CommandLineUtils
- java.lang.Object
-
- org.codehaus.plexus.util.cli.CommandLineUtils
-
public abstract class CommandLineUtils extends java.lang.Object
- Version:
- $Id$
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CommandLineUtils.StringStreamConsumer
AStreamConsumer
providing consumed lines as aString
.
-
Field Summary
Fields Modifier and Type Field Description private static long
MILLIS_PER_SECOND
Number of milliseconds per second.private static long
NANOS_PER_SECOND
Number of nanoseconds per second.
-
Constructor Summary
Constructors Constructor Description CommandLineUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static int
executeCommandLine(Commandline cl, java.io.InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr)
static int
executeCommandLine(Commandline cl, java.io.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, java.io.InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr, int timeoutInSeconds)
Immediately forks a process, returns a callable that will block until process is complete.static java.util.Properties
getSystemEnvVars()
Gets the shell environment variables for this process.static java.util.Properties
getSystemEnvVars(boolean caseSensitive)
Return the shell environment variables.private static void
handleException(StreamFeeder streamFeeder, java.lang.String streamName)
private static void
handleException(StreamPumper streamPumper, java.lang.String streamName)
static boolean
isAlive(java.lang.Process p)
static java.lang.String
quote(java.lang.String argument)
static java.lang.String
quote(java.lang.String argument, boolean wrapExistingQuotes)
static java.lang.String
quote(java.lang.String argument, boolean escapeSingleQuotes, boolean escapeDoubleQuotes, boolean wrapExistingQuotes)
static java.lang.String
toString(java.lang.String[] line)
static java.lang.String[]
translateCommandline(java.lang.String toProcess)
-
-
-
Field Detail
-
MILLIS_PER_SECOND
private static final long MILLIS_PER_SECOND
Number of milliseconds per second.- See Also:
- Constant Field Values
-
NANOS_PER_SECOND
private static final long NANOS_PER_SECOND
Number of nanoseconds per second.- See Also:
- Constant Field Values
-
-
Method Detail
-
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, java.io.InputStream systemIn, StreamConsumer systemOut, StreamConsumer systemErr) throws CommandLineException
- Throws:
CommandLineException
-
executeCommandLine
public static int executeCommandLine(Commandline cl, java.io.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, java.io.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
-
handleException
private static void handleException(StreamPumper streamPumper, java.lang.String streamName) throws CommandLineException
- Throws:
CommandLineException
-
handleException
private static void handleException(StreamFeeder streamFeeder, java.lang.String streamName) throws CommandLineException
- Throws:
CommandLineException
-
getSystemEnvVars
public static java.util.Properties getSystemEnvVars() throws java.io.IOException
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
. - Throws:
java.io.IOException
- If the environment variables could not be queried from the shell.- See Also:
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.
-
getSystemEnvVars
public static java.util.Properties getSystemEnvVars(boolean caseSensitive) throws java.io.IOException
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.
- Throws:
java.io.IOException
- .- See Also:
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.
-
isAlive
public static boolean isAlive(java.lang.Process p)
-
translateCommandline
public static java.lang.String[] translateCommandline(java.lang.String toProcess) throws java.lang.Exception
- Throws:
java.lang.Exception
-
quote
public static java.lang.String quote(java.lang.String argument) 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.
- Throws:
CommandLineException
- if the argument contains both, single and double quotes.
-
quote
public static java.lang.String quote(java.lang.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.
- Throws:
CommandLineException
- if the argument contains both, single and double quotes.
-
quote
public static java.lang.String quote(java.lang.String argument, boolean escapeSingleQuotes, boolean escapeDoubleQuotes, boolean wrapExistingQuotes) throws CommandLineException
Deprecated.- Throws:
CommandLineException
-
toString
public static java.lang.String toString(java.lang.String[] line)
-
-