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 |
|---|---|
| private static class | |
| 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. |
| private static class |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public static void | closeStreams(Process
a Process self)Closes all the streams associated with the process (ignoring any IOExceptions). |
| public static Thread | Returns: the Threada Process self, OutputStream an OutputStream to capture the process stderr err)Gets the error stream from a process and reads it to keep the process from blocking due to a full buffer. |
| public static Thread | Returns: the Threada Process self, Appendable an Appendable to capture the process stderr error)Gets the error stream from a process and reads it to keep the process from blocking due to a full buffer. |
| public static void | consumeProcessOutput(Process
a 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. |
| public static void | consumeProcessOutput(Process
a Process self, Appendable an Appendable to capture the process stdout output, Appendable an Appendable to capture the process stderr 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. |
| public static void | consumeProcessOutput(Process
a Process self, OutputStream an OutputStream to capture the process stdout output, OutputStream an OutputStream to capture the process stderr 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. |
| public static Thread | Returns: the Threada Process self, Appendable an Appendable to capture the process stdout output)Gets the output stream from a process and reads it to keep the process from blocking due to a full output buffer. |
| public static Thread | Returns: the Threada Process self, OutputStream an OutputStream to capture the process stdout output)Gets the output stream from a process and reads it to keep the process from blocking due to a full output buffer. |
| public static Process | |
| public static Process | Returns: the Process which has just started for this command line representation.a command line String to be executed. self, final String[] 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. envp, final File the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process. dir)Executes the command specified by |
| public static Process | Returns: the Process which has just started for this command line representation.a command line String to be executed. self, final List<E> 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. envp, final File the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process. dir)Executes the command specified by |
| public static Process | |
| public static Process | Returns: the Process which has just started for this command line representation.an array of commandArray, final String[] String containing the command name and
parameters as separate items in the array.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. envp, final File the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process. dir)Executes the command specified by the |
| public static Process | Returns: the Process which has just started for this command line representation.an array of commandArray, final List<E> String containing the command name and
parameters as separate items in the array.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. envp, final File the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process. dir)Executes the command specified by the |
| public static Process | |
| public static Process | Returns: the Process which has just started for this command line representation.a List containing the command name and
parameters as separate items in the list. commands, final String[] 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. envp, final File the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process. dir)Executes the command specified by the given list,
with the environment defined by |
| public static Process | Returns: the Process which has just started for this command line representation.a List containing the command name and
parameters as separate items in the list. commands, final List<E> 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. envp, final File the working directory of the subprocess, or
null if the subprocess should inherit
the working directory of the current process. dir)Executes the command specified by the given list,
with the environment defined by |
| public static InputStream | |
| public static InputStream | |
| public static OutputStream | |
| public static String | |
| public static Writer | |
| public static OutputStream | |
| public static Process | |
| public static Process | |
| private static String[] | |
| public static void | waitForOrKill(Process
a Process self, long the number of milliseconds to wait before stopping the process numberOfMillis)Wait for the process to finish during a certain amount of time, otherwise stops the process. |
| public static void | waitForProcessOutput(Process
a 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. |
| public static void | waitForProcessOutput(Process
a Process self, Appendable an Appendable to capture the process stdout output, Appendable an Appendable to capture the process stderr 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. |
| public static void | waitForProcessOutput(Process
a Process self, OutputStream an OutputStream to capture the process stdout output, OutputStream an OutputStream to capture the process stderr 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. |
| public static void | withOutputStream(final Process
a Process self, final Closure<V> a 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. |
| public static void | withWriter(final Process
a Process self, final Closure<V> a 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. |
| ProcessGroovyMethods | back to summary |
|---|---|
| public ProcessGroovyMethods() | |
| closeStreams | back to summary |
|---|---|
| public static void closeStreams(Process self) Closes all the streams associated with the process (ignoring any IOExceptions).
| |
| consumeProcessErrorStream | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied OutputStream. A new Thread is started, so this method will return immediately.
| |
| consumeProcessErrorStream | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied Appendable. A new Thread is started, so this method will return immediately.
| |
| consumeProcessOutput | back to summary |
|---|---|
| public 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. The stream data is thrown away but blocking due to a full output buffer is avoided. Use this method if you don't care about the standard or error output and just want the process to run silently - use carefully however, because since the stream data is thrown away, it might be difficult to track down when something goes wrong. For this, two Threads are started, so this method will return immediately.
| |
| consumeProcessOutput | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied Appendable. For this, two Threads are started, so this method will return immediately. The threads will not be join()ed, even if waitFor() is called. To wait for the output to be fully consumed call waitForProcessOutput().
| |
| consumeProcessOutput | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied OutputStream. For this, two Threads are started, so this method will return immediately. The threads will not be join()ed, even if waitFor() is called. To wait for the output to be fully consumed call waitForProcessOutput().
| |
| consumeProcessOutputStream | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied Appendable. A new Thread is started, so this method will return immediately.
| |
| consumeProcessOutputStream | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied OutputStream. A new Thread is started, so this method will return immediately.
| |
| execute | back to summary |
|---|---|
| public static Process execute(final String self) throws IOException Executes the command specified by For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final String self, final String[] envp, final File dir) throws IOException Executes the command specified by For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final String self, final List<E> envp, final File dir) throws IOException Executes the command specified by For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final String[] commandArray) throws IOException Executes the command specified by the given For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final String[] commandArray, final String[] envp, final File dir) throws IOException Executes the command specified by the For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final String[] commandArray, final List<E> envp, final File dir) throws IOException Executes the command specified by the For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final List<E> commands) throws IOException Executes the command specified by the given list. The toString() method is called for each item in the list to convert into a resulting String. The first item in the list is the command the others are the parameters. For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final List<E> commands, final String[] envp, final File dir) throws IOException Executes the command specified by the given list,
with the environment defined by For more control over Process construction you can use
| |
| execute | back to summary |
|---|---|
| public static Process execute(final List<E> commands, final List<E> envp, final File dir) throws IOException Executes the command specified by the given list,
with the environment defined by For more control over Process construction you can use
| |
| getErr | back to summary |
|---|---|
| public 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.
| |
| getIn | back to summary |
|---|---|
| public 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.
| |
| getOut | back to summary |
|---|---|
| public 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.
| |
| getText | back to summary |
|---|---|
| public static String getText(Process self) throws IOException Read the text of the output stream of the Process. Closes all the streams associated with the process after retrieving the text.
| |
| leftShift | back to summary |
|---|---|
| public static Writer leftShift(Process self, Object value) throws IOException Overloads the left shift operator (<<) to provide an append mechanism to pipe data to a Process.
| |
| leftShift | back to summary |
|---|---|
| public static OutputStream leftShift(Process self, byte[] value) throws IOException Overloads the left shift operator to provide an append mechanism to pipe into a Process
| |
| or | back to summary |
|---|---|
| public static Process or(final Process left, final Process right) throws IOException Overrides the or operator to allow one Process to asynchronously pipe data to another Process.
| |
| pipeTo | back to summary |
|---|---|
| public static Process pipeTo(final Process left, final Process right) throws IOException Allows one Process to asynchronously pipe data to another Process.
| |
| stringify | back to summary |
|---|---|
| private static String[] stringify(final List<E> orig) | |
| waitForOrKill | back to summary |
|---|---|
| public static void waitForOrKill(Process self, long numberOfMillis) Wait for the process to finish during a certain amount of time, otherwise stops the process.
| |
| waitForProcessOutput | back to summary |
|---|---|
| public 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. The stream data is thrown away but blocking due to a full output buffer is avoided. Use this method if you don't care about the standard or error output and just want the process to run silently - use carefully however, because since the stream data is thrown away, it might be difficult to track down when something goes wrong. For this, two Threads are started, but join()ed, so we wait. As implied by the waitFor... name, we also wait until we finish as well. Finally, the output and error streams are closed.
| |
| waitForProcessOutput | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied Appendable. For this, two Threads are started, but join()ed, so we wait. As implied by the waitFor... name, we also wait until we finish as well. Finally, the input, output and error streams are closed.
| |
| waitForProcessOutput | back to summary |
|---|---|
| public 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. The processed stream data is appended to the supplied OutputStream. For this, two Threads are started, but join()ed, so we wait. As implied by the waitFor... name, we also wait until we finish as well. Finally, the input, output and error streams are closed.
| |
| withOutputStream | back to summary |
|---|---|
| public static void withOutputStream(final Process self, final Closure<V> 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. A new Thread is started, so this method will return immediately. | |
| withWriter | back to summary |
|---|---|
| public static void withWriter(final Process self, final Closure<V> 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. A new Thread is started, so this method will return immediately. | |
| Modifier and Type | Field and Description |
|---|---|
| pack-priv final InputStream | |
| pack-priv final OutputStream |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void |
| in | back to summary |
|---|---|
| pack-priv final InputStream in | |
| out | back to summary |
|---|---|
| pack-priv final OutputStream out | |
| ByteDumper | back to summary |
|---|---|
| public ByteDumper(InputStream in, OutputStream out) | |
| run | back to summary |
|---|---|
| public void run() Implements java. Doc from java. Runs this operation. | |
| Modifier and Type | Field and Description |
|---|---|
| private boolean | |
| pack-priv Process |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| private void | |
| public void | |
| public synchronized void |
| finished | back to summary |
|---|---|
| private boolean finished | |
| process | back to summary |
|---|---|
| pack-priv Process process | |
| ProcessRunner | back to summary |
|---|---|
| public ProcessRunner(Process process) | |
| doProcessWait | back to summary |
|---|---|
| private void doProcessWait() | |
| run | back to summary |
|---|---|
| public void run() Implements java. Doc from java. Runs this operation. | |
| waitForOrKill | back to summary |
|---|---|
| public synchronized void waitForOrKill(long millis) | |
| Modifier and Type | Field and Description |
|---|---|
| pack-priv final Appendable | |
| pack-priv final InputStream |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void |
| app | back to summary |
|---|---|
| pack-priv final Appendable app | |
| in | back to summary |
|---|---|
| pack-priv final InputStream in | |
| TextDumper | back to summary |
|---|---|
| public TextDumper(InputStream in, Appendable app) | |
| run | back to summary |
|---|---|
| public void run() Implements java. Doc from java. Runs this operation. | |