public class ProcessGroovyMethods extends DefaultGroovyMethodsSupport
Static methods are used with the first parameter being the destination class,
i.e. public static String reverse(String self)
provides a reverse() method for String.
NOTE: While this class contains many 'public' static methods, it is primarily regarded as an internal class (its internal package name suggests this also). We value backwards compatibility of these methods when used within Groovy but value less backwards compatibility at the Java method call level. I.e. future versions of Groovy may remove or move a method call in this file but would normally aim to keep the method available from within Groovy.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
ProcessGroovyMethods.ProcessRunner
A Runnable which waits for a process to complete together with a notification scheme
allowing another thread to wait a maximum number of seconds for the process to complete
before killing it.
|
| Constructor and Description |
|---|
ProcessGroovyMethods() |
| Modifier and Type | Method and Description |
|---|---|
static void |
closeStreams(Process self)
Closes all the streams associated with the process (ignoring any IOExceptions).
|
static Thread |
consumeProcessErrorStream(Process self,
Appendable error)
Gets the error stream from a process and reads it
to keep the process from blocking due to a full buffer.
|
static Thread |
consumeProcessErrorStream(Process self,
OutputStream err)
Gets the error stream from a process and reads it
to keep the process from blocking due to a full buffer.
|
static void |
consumeProcessOutput(Process self)
Gets the output and error streams from a process and reads them
to keep the process from blocking due to a full output buffer.
|
static void |
consumeProcessOutput(Process self,
Appendable output,
Appendable error)
Gets the output and error streams from a process and reads them
to keep the process from blocking due to a full output buffer.
|
static void |
consumeProcessOutput(Process self,
OutputStream output,
OutputStream error)
Gets the output and error streams from a process and reads them
to keep the process from blocking due to a full output buffer.
|
static Thread |
consumeProcessOutputStream(Process self,
Appendable output)
Gets the output stream from a process and reads it
to keep the process from blocking due to a full output buffer.
|
static Thread |
consumeProcessOutputStream(Process self,
OutputStream output)
Gets the output stream from a process and reads it
to keep the process from blocking due to a full output buffer.
|
static Process |
execute(List commands)
Executes the command specified by the given list.
|
static Process |
execute(List commands,
List envp,
File dir)
Executes the command specified by the given list,
with the environment defined by
envp and under the working directory dir. |
static Process |
execute(List commands,
String[] envp,
File dir)
Executes the command specified by the given list,
with the environment defined by
envp and under the working directory dir. |
static Process |
execute(String self)
Executes the command specified by
self as a command-line process. |
static Process |
execute(String[] commandArray)
Executes the command specified by the given
String array. |
static Process |
execute(String[] commandArray,
List envp,
File dir)
Executes the command specified by the
String array given in the first parameter,
with the environment defined by envp and under the working directory dir. |
static Process |
execute(String[] commandArray,
String[] envp,
File dir)
Executes the command specified by the
String array given in the first parameter,
with the environment defined by envp and under the working directory dir. |
static Process |
execute(String self,
List envp,
File dir)
Executes the command specified by
self with environment defined
by envp and under the working directory dir. |
static Process |
execute(String self,
String[] envp,
File dir)
Executes the command specified by
self with environment defined by envp
and under the working directory dir. |
static InputStream |
getErr(Process self)
An alias method so that a process appears similar to System.out, System.in, System.err;
you can use process.in, process.out, process.err in a similar fashion.
|
static InputStream |
getIn(Process self)
An alias method so that a process appears similar to System.out, System.in, System.err;
you can use process.in, process.out, process.err in a similar fashion.
|
static OutputStream |
getOut(Process self)
An alias method so that a process appears similar to System.out, System.in, System.err;
you can use process.in, process.out, process.err in a similar fashion.
|
static String |
getText(Process self)
Read the text of the output stream of the Process.
|
static OutputStream |
leftShift(Process self,
byte[] value)
Overloads the left shift operator to provide an append mechanism
to pipe into a Process
|
static Writer |
leftShift(Process self,
Object value)
Overloads the left shift operator (<<) to provide an append mechanism
to pipe data to a Process.
|
static Process |
or(Process left,
Process right)
Overrides the or operator to allow one Process to asynchronously
pipe data to another Process.
|
static Process |
pipeTo(Process left,
Process right)
Allows one Process to asynchronously pipe data to another Process.
|
static void |
waitForOrKill(Process self,
long numberOfMillis)
Wait for the process to finish during a certain amount of time, otherwise stops the process.
|
static void |
waitForProcessOutput(Process self)
Gets the output and error streams from a process and reads them
to keep the process from blocking due to a full output buffer.
|
static void |
waitForProcessOutput(Process self,
Appendable output,
Appendable error)
Gets the output and error streams from a process and reads them
to keep the process from blocking due to a full output buffer.
|
static void |
waitForProcessOutput(Process self,
OutputStream output,
OutputStream error)
Gets the output and error streams from a process and reads them
to keep the process from blocking due to a full output buffer.
|
static void |
withOutputStream(Process self,
Closure closure)
Creates a new buffered OutputStream as stdin for this process,
passes it to the closure, and ensures the stream is flushed
and closed after the closure returns.
|
static void |
withWriter(Process self,
Closure closure)
Creates a new BufferedWriter as stdin for this process,
passes it to the closure, and ensures the stream is flushed
and closed after the closure returns.
|
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorderspublic static InputStream getIn(Process self)
self - a Process instancepublic static String getText(Process self) throws IOException
self - a Process instanceIOException - if an IOException occurs.public static InputStream getErr(Process self)
self - a Process instancepublic static OutputStream getOut(Process self)
self - a Process instancepublic static Writer leftShift(Process self, Object value) throws IOException
self - a Process instancevalue - a value to appendIOException - if an IOException occurs.public static OutputStream leftShift(Process self, byte[] value) throws IOException
self - a Process instancevalue - data to appendIOException - if an IOException occurs.public static void waitForOrKill(Process self, long numberOfMillis)
self - a ProcessnumberOfMillis - the number of milliseconds to wait before stopping the processpublic static void closeStreams(Process self)
self - a Processpublic static void consumeProcessOutput(Process self)
self - a Processpublic static void consumeProcessOutput(Process self, Appendable output, Appendable error)
self - a Processoutput - an Appendable to capture the process stdouterror - an Appendable to capture the process stderrpublic static void consumeProcessOutput(Process self, OutputStream output, OutputStream error)
self - a Processoutput - an OutputStream to capture the process stdouterror - an OutputStream to capture the process stderrpublic static void waitForProcessOutput(Process self)
self - a Processpublic static void waitForProcessOutput(Process self, Appendable output, Appendable error)
self - a Processoutput - an Appendable to capture the process stdouterror - an Appendable to capture the process stderrpublic static void waitForProcessOutput(Process self, OutputStream output, OutputStream error)
self - a Processoutput - an OutputStream to capture the process stdouterror - an OutputStream to capture the process stderrpublic static Thread consumeProcessErrorStream(Process self, OutputStream err)
self - a Processerr - an OutputStream to capture the process stderrpublic static Thread consumeProcessErrorStream(Process self, Appendable error)
self - a Processerror - an Appendable to capture the process stderrpublic static Thread consumeProcessOutputStream(Process self, Appendable output)
self - a Processoutput - an Appendable to capture the process stdoutpublic static Thread consumeProcessOutputStream(Process self, OutputStream output)
self - a Processoutput - an OutputStream to capture the process stdoutpublic static void withWriter(Process self, Closure closure)
self - a Processclosure - a closurepublic static void withOutputStream(Process self, Closure closure)
self - a Processclosure - a closurepublic static Process pipeTo(Process left, Process right) throws IOException
left - a Process instanceright - a Process to pipe output toIOException - if an IOException occurs.public static Process or(Process left, Process right) throws IOException
left - a Process instanceright - a Process to pipe output toIOException - if an IOException occurs.public static Process execute(String self) throws IOException
self as a command-line process.
For more control over Process construction you can use
java.lang.ProcessBuilder.
self - a command line StringIOException - if an IOException occurs.public static Process execute(String self, String[] envp, File dir) throws IOException
self with environment defined by envp
and under the working directory dir.
For more control over Process construction you can use
java.lang.ProcessBuilder.
self - a command line String to be executed.envp - an array of Strings, each element of which
has environment variable settings in the format
name=value, or
null if the subprocess should inherit
the environment of the current process.dir - the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process.IOException - if an IOException occurs.public static Process execute(String self, List envp, File dir) throws IOException
self with environment defined
by envp and under the working directory dir.
For more control over Process construction you can use
java.lang.ProcessBuilder.
self - a command line String to be executed.envp - a List of Objects (converted to Strings using toString), each member of which
has environment variable settings in the format
name=value, or
null if the subprocess should inherit
the environment of the current process.dir - the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process.IOException - if an IOException occurs.public static Process execute(String[] commandArray) throws IOException
String array.
The first item in the array is the command; the others are the parameters.
For more control over Process construction you can use
java.lang.ProcessBuilder.
commandArray - an array of String containing the command name and
parameters as separate items in the array.IOException - if an IOException occurs.public static Process execute(String[] commandArray, String[] envp, File dir) throws IOException
String array given in the first parameter,
with the environment defined by envp and under the working directory dir.
The first item in the array is the command; the others are the parameters.
For more control over Process construction you can use
java.lang.ProcessBuilder.
commandArray - an array of String containing the command name and
parameters as separate items in the array.envp - an array of Strings, each member of which
has environment variable settings in the format
name=value, or
null if the subprocess should inherit
the environment of the current process.dir - the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process.IOException - if an IOException occurs.public static Process execute(String[] commandArray, List envp, File dir) throws IOException
String array given in the first parameter,
with the environment defined by envp and under the working directory dir.
The first item in the array is the command; the others are the parameters.
For more control over Process construction you can use
java.lang.ProcessBuilder.
commandArray - an array of String containing the command name and
parameters as separate items in the array.envp - a List of Objects (converted to Strings using toString), each member of which
has environment variable settings in the format
name=value, or
null if the subprocess should inherit
the environment of the current process.dir - the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process.IOException - if an IOException occurs.public static Process execute(List commands) throws IOException
For more control over Process construction you can use
java.lang.ProcessBuilder.
commands - a list containing the command name and
parameters as separate items in the list.IOException - if an IOException occurs.public static Process execute(List commands, String[] envp, File dir) throws IOException
envp and under the working directory dir.
The first item in the list is the command; the others are the parameters. The toString()
method is called on items in the list to convert them to Strings.
For more control over Process construction you can use
java.lang.ProcessBuilder.
commands - a List containing the command name and
parameters as separate items in the list.envp - an array of Strings, each member of which
has environment variable settings in the format
name=value, or
null if the subprocess should inherit
the environment of the current process.dir - the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process.IOException - if an IOException occurs.public static Process execute(List commands, List envp, File dir) throws IOException
envp and under the working directory dir.
The first item in the list is the command; the others are the parameters. The toString()
method is called on items in the list to convert them to Strings.
For more control over Process construction you can use
java.lang.ProcessBuilder.
commands - a List containing the command name and
parameters as separate items in the list.envp - a List of Objects (converted to Strings using toString), each member of which
has environment variable settings in the format
name=value, or
null if the subprocess should inherit
the environment of the current process.dir - the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process.IOException - if an IOException occurs.