to.etc.util

Class ProcessTools

java.lang.Object

to.etc.util.ProcessTools

public final class ProcessTools
extends Object

Helper code to spawn processes and capture their output.

Author:

Frits Jalvingh Created on Nov 25, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProcessTools.IFollow
static class	ProcessTools.StreamCopyThread This is used to async read strout and stderr streams from a process into another output stream.
static class	ProcessTools.StreamReaderThread This is used to async read strout and stderr streams from a process...

Constructor Summary

Constructors

Constructor and Description
ProcessTools()
ProcessTools(ProcessBuilder pb)

Method Summary

Modifier and Type	Method and Description
ProcessTools	add(List<String> cmd)
ProcessTools	add(String... args)
ProcessTools	add(String cmd)
ProcessTools	directory(File cmd)
static int	dumpStreams(Process pr, Appendable iosb) Waits for completion of the command and collect data into the streams.
Map<String,String>	env()
ProcessTools	envStrip(String... names)
ProcessTools	flush()
ProcessTools	follow(ProcessTools.IFollow cmd)
int	run()
static int	runProcess(ProcessBuilder pb, Appendable sb) Runs the process whose data is in the ProcessBuilder and captures the result with stdout and stderr merged.
static int	runProcess(ProcessBuilder pb, Appendable outsb, Appendable errsb) Runs the process whose data is in the ProcessBuilder and captures the result with stdout and stderr merged.
static int	runProcess(ProcessBuilder pb, OutputStream stdout, Appendable stderrsb) Runs the process whose data is in the ProcessBuilder and captures the result.
static int	runProcess(ProcessBuilder pb, Writer out) Runs the process whose data is in the ProcessBuilder and captures the result with stdout and stderr merged into a writer.
ProcessTools	setCommand(List<String> cmd)
ProcessTools	stderr(Writer stderr)
ProcessTools	stdout(Writer stdout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessTools

public ProcessTools()

ProcessTools

public ProcessTools(@Nonnull
                    ProcessBuilder pb)

Method Detail

stdout

@Nonnull
public ProcessTools stdout(@Nonnull
                                    Writer stdout)

stderr

@Nonnull
public ProcessTools stderr(@Nonnull
                                    Writer stderr)

add

@Nonnull
public ProcessTools add(@Nonnull
                                 String cmd)

add

@Nonnull
public ProcessTools add(@Nonnull
                                 List<String> cmd)

add

@Nonnull
public ProcessTools add(String... args)

setCommand

@Nonnull
public ProcessTools setCommand(@Nonnull
                                        List<String> cmd)

directory

@Nonnull
public ProcessTools directory(@Nonnull
                                       File cmd)

follow

@Nonnull
public ProcessTools follow(@Nonnull
                                    ProcessTools.IFollow cmd)

flush

@Nonnull
public ProcessTools flush()

env

@Nonnull
public Map<String,String> env()

envStrip

@Nonnull
public ProcessTools envStrip(@Nonnull
                                      String... names)

run

public int run()
        throws Exception

Throws:

Exception

dumpStreams

public static int dumpStreams(Process pr,
                              Appendable iosb)
                       throws Exception

Waits for completion of the command and collect data into the streams.

Throws:

Exception

runProcess

public static int runProcess(ProcessBuilder pb,
                             Appendable sb)
                      throws Exception

Runs the process whose data is in the ProcessBuilder and captures the result with stdout and stderr merged.

Parameters:

pb -

sb -

Returns:

Throws:

Exception

runProcess

public static int runProcess(ProcessBuilder pb,
                             OutputStream stdout,
                             Appendable stderrsb)
                      throws Exception

Runs the process whose data is in the ProcessBuilder and captures the result.

Parameters:

pb -

sb -

Returns:

Throws:

Exception

runProcess

public static int runProcess(ProcessBuilder pb,
                             Appendable outsb,
                             Appendable errsb)
                      throws Exception

Runs the process whose data is in the ProcessBuilder and captures the result with stdout and stderr merged.

Parameters:

pb -

sb -

Returns:

Throws:

Exception

runProcess

public static int runProcess(ProcessBuilder pb,
                             Writer out)
                      throws Exception

Runs the process whose data is in the ProcessBuilder and captures the result with stdout and stderr merged into a writer.

Parameters:

pb -

sb -

Returns:

Throws:

Exception