com.jn.langx.commandline

类 PumpStreamHandler

java.lang.Object

com.jn.langx.commandline.PumpStreamHandler

所有已实现的接口:

ExecuteStreamHandler

public class PumpStreamHandler
extends Object
implements ExecuteStreamHandler

Copies standard output and error of sub-processes to standard output and error of the parent process. If output or error stream are set to null, any feedback from that stream will be lost.

版本:

$Id: PumpStreamHandler.java 1557263 2014-01-10 21:18:09Z ggregory $

构造器概要

构造器

构造器和说明
PumpStreamHandler() Construct a new PumpStreamHandler.
PumpStreamHandler(OutputStream outAndErr) Construct a new PumpStreamHandler.
PumpStreamHandler(OutputStream out, OutputStream err) Construct a new PumpStreamHandler.
PumpStreamHandler(OutputStream out, OutputStream err, InputStream input) Construct a new PumpStreamHandler.

方法概要

限定符和类型	方法和说明
protected void	createProcessErrorPump(InputStream is, OutputStream os) Create the pump to handle error output.
protected void	createProcessOutputPump(InputStream is, OutputStream os) Create the pump to handle process output.
protected Thread	createPump(InputStream is, OutputStream os) Creates a stream pumper to copy the given input stream to the given output stream.
protected Thread	createPump(InputStream is, OutputStream os, boolean closeWhenExhausted) Creates a stream pumper to copy the given input stream to the given output stream.
protected OutputStream	getErr() Get the error stream.
protected OutputStream	getOut() Get the output stream.
void	setProcessErrorStream(InputStream is) Set the InputStream from which to read the standard error of the process.
void	setProcessInputStream(OutputStream os) Set the OutputStream by means of which input can be sent to the process.
void	setProcessOutputStream(InputStream is) Set the InputStream from which to read the standard output of the process.
void	setStopTimeout(long timeout) Set maximum time to wait until output streams are exchausted when stop() was called.
void	start() Start the Threads.
void	stop() Stop pumping the streams.
protected void	stopThread(Thread thread, long timeout) Stopping a pumper thread.

从类继承的方法 java.lang.Object

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

构造器详细资料

PumpStreamHandler

public PumpStreamHandler()

Construct a new PumpStreamHandler.

PumpStreamHandler

public PumpStreamHandler(OutputStream outAndErr)

Construct a new PumpStreamHandler.

参数:

outAndErr - the output/error OutputStream.

PumpStreamHandler

public PumpStreamHandler(OutputStream out,
                         OutputStream err)

Construct a new PumpStreamHandler.

参数:

out - the output OutputStream.

err - the error OutputStream.

PumpStreamHandler

public PumpStreamHandler(OutputStream out,
                         OutputStream err,
                         InputStream input)

Construct a new PumpStreamHandler.

参数:

out - the output OutputStream.

err - the error OutputStream.

input - the input InputStream.

方法详细资料

setStopTimeout

public void setStopTimeout(long timeout)

Set maximum time to wait until output streams are exchausted when stop() was called.

参数:

timeout - timeout in milliseconds or zero to wait forever (default)

setProcessOutputStream

public void setProcessOutputStream(InputStream is)

Set the InputStream from which to read the standard output of the process.

指定者:

setProcessOutputStream 在接口中 ExecuteStreamHandler

参数:

is - the InputStream.

setProcessErrorStream

public void setProcessErrorStream(InputStream is)

Set the InputStream from which to read the standard error of the process.

指定者:

setProcessErrorStream 在接口中 ExecuteStreamHandler

参数:

is - the InputStream.

setProcessInputStream

public void setProcessInputStream(OutputStream os)

Set the OutputStream by means of which input can be sent to the process.

指定者:

setProcessInputStream 在接口中 ExecuteStreamHandler

参数:

os - the OutputStream.

start

public void start()

Start the Threads.

指定者:

start 在接口中 ExecuteStreamHandler

stop

public void stop()
          throws IOException

Stop pumping the streams. When a timeout is specified it it is not guaranteed that the pumper threads are cleanly terminated.

指定者:

stop 在接口中 ExecuteStreamHandler

抛出:

IOException - thrown when an I/O exception occurs.

getErr

protected OutputStream getErr()

Get the error stream.

返回:

OutputStream.

getOut

protected OutputStream getOut()

Get the output stream.

返回:

OutputStream.

createProcessOutputPump

protected void createProcessOutputPump(InputStream is,
                                       OutputStream os)

Create the pump to handle process output.

参数:

is - the InputStream.

os - the OutputStream.

createProcessErrorPump

protected void createProcessErrorPump(InputStream is,
                                      OutputStream os)

Create the pump to handle error output.

参数:

is - the InputStream.

os - the OutputStream.

createPump

protected Thread createPump(InputStream is,
                            OutputStream os)

Creates a stream pumper to copy the given input stream to the given output stream. When the 'os' is an PipedOutputStream we are closing 'os' afterwards to avoid an IOException ("Write end dead").

参数:

is - the input stream to copy from

os - the output stream to copy into

返回:

the stream pumper thread

createPump

protected Thread createPump(InputStream is,
                            OutputStream os,
                            boolean closeWhenExhausted)

Creates a stream pumper to copy the given input stream to the given output stream.

参数:

is - the input stream to copy from

os - the output stream to copy into

closeWhenExhausted - close the output stream when the input stream is exhausted

返回:

the stream pumper thread

stopThread

protected void stopThread(Thread thread,
                          long timeout)

Stopping a pumper thread. The implementation actually waits longer than specified in 'timeout' to detect if the timeout was indeed exceeded. If the timeout was exceeded an IOException is created to be thrown to the caller.

参数:

thread - the thread to be stopped

timeout - the time in ms to wait to join