Apache Ant 1.10.14 · org.apache.tools.ant.taskdefs.PumpStreamHandler

Modifier and Type	Class and Description
protected static class	PumpStreamHandler.ThreadWithPumper Specialized subclass that allows access to the running StreamPumper.

Modifier and Type	Field and Description
private OutputStream	err
private Thread	errorThread
private InputStream	input
private Thread	inputThread
private static final long	JOIN_TIMEOUT
private final boolean	nonBlockingRead
private OutputStream	out
private Thread	outputThread

Constructor Summary

Access	Constructor and Description
public	PumpStreamHandler(OutputStream the output `OutputStream`, must not be null. out, OutputStream the error `OutputStream`, must not be null. err, InputStream the input `InputStream`. input, boolean set it to `true` if the input should be read with simulated non blocking IO. nonBlockingRead) Construct a new `PumpStreamHandler`.
public	PumpStreamHandler(OutputStream the output `OutputStream`, must not be null. out, OutputStream the error `OutputStream`, must not be null. err, InputStream the input `InputStream`. input) Construct a new `PumpStreamHandler`.
public	PumpStreamHandler(OutputStream the output `OutputStream`, must not be null. out, OutputStream the error `OutputStream`, must not be null. err) Construct a new `PumpStreamHandler`.
public	PumpStreamHandler(OutputStream the output/error `OutputStream`, must not be null. outAndErr) Construct a new `PumpStreamHandler`.
public	PumpStreamHandler() Construct a new `PumpStreamHandler`.

Method Summary

Modifier and Type	Method and Description
protected void	createProcessErrorPump(InputStream the input stream to copy from. is, OutputStream the output stream to copy to. os) Create the pump to handle error output.
protected void	createProcessOutputPump(InputStream the `InputStream`. is, OutputStream the `OutputStream`. os) Create the pump to handle process output.
protected Thread	Returns: a thread object that does the pumping. createPump(InputStream the input stream to copy from. is, OutputStream the output stream to copy to. os) Creates a stream pumper to copy the given input stream to the given output stream.
protected Thread	Returns: a thread object that does the pumping, subclasses should return an instance of `ThreadWithPumper`. createPump(InputStream the input stream to copy from. is, OutputStream the output stream to copy to. os, boolean if true close the inputstream. closeWhenExhausted) Creates a stream pumper to copy the given input stream to the given output stream.
protected Thread	Returns: a thread object that does the pumping, subclasses should return an instance of `ThreadWithPumper`. createPump(InputStream the input stream to copy from. is, OutputStream the output stream to copy to. os, boolean if true close the inputstream. closeWhenExhausted, boolean set it to `true` to use simulated non blocking IO. nonBlockingIO) Creates a stream pumper to copy the given input stream to the given output stream.
protected final void	finish(Thread Thread t) Waits for a thread to finish while trying to make it finish quicker by stopping the pumper (if the thread is a `ThreadWithPumper` instance) or interrupting the thread.
protected OutputStream	Returns: `OutputStream`. getErr() Get the error stream.
protected OutputStream	Returns: `OutputStream`. getOut() Get the output stream.
public void	setProcessErrorStream(InputStream the `InputStream`. is) Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessErrorStream. Set the `InputStream` from which to read the standard error of the process.
public void	setProcessInputStream(OutputStream the `OutputStream`. os) Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessInputStream. Set the `OutputStream` by means of which input can be sent to the process.
public void	setProcessOutputStream(InputStream the `InputStream`. is) Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessOutputStream. Set the `InputStream` from which to read the standard output of the process.
public void	start() Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.start. Start the `Thread`s.
private void	start(Thread t)
public void	stop() Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.stop. Stop pumping the streams.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

err	back to summary
private OutputStream err

errorThread	back to summary
private Thread errorThread

input	back to summary
private InputStream input

inputThread	back to summary
private Thread inputThread

JOIN_TIMEOUT	back to summary
private static final long JOIN_TIMEOUT

nonBlockingRead	back to summary
private final boolean nonBlockingRead

out	back to summary
private OutputStream out

outputThread	back to summary
private Thread outputThread

Constructor Detail

PumpStreamHandler back to summary

PumpStreamHandler	back to summary
public PumpStreamHandler(OutputStream out, OutputStream err, InputStream input, boolean nonBlockingRead) Construct a new `PumpStreamHandler`. Parameters out:OutputStream the output `OutputStream`, must not be null. err:OutputStream the error `OutputStream`, must not be null. input:InputStream the input `InputStream`. nonBlockingRead:boolean set it to `true` if the input should be read with simulated non blocking IO.

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

Construct a new PumpStreamHandler.

Parameters

out:OutputStream: the output OutputStream, must not be null.
err:OutputStream: the error OutputStream, must not be null.
input:InputStream: the input InputStream.
nonBlockingRead:boolean: set it to true if the input should be read with simulated non blocking IO.

PumpStreamHandler back to summary

PumpStreamHandler	back to summary
public PumpStreamHandler(OutputStream out, OutputStream err, InputStream input) Construct a new `PumpStreamHandler`. Parameters out:OutputStream the output `OutputStream`, must not be null. err:OutputStream the error `OutputStream`, must not be null. input:InputStream the input `InputStream`.

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

Construct a new PumpStreamHandler.

Parameters

out:OutputStream: the output OutputStream, must not be null.
err:OutputStream: the error OutputStream, must not be null.
input:InputStream: the input InputStream.

PumpStreamHandler back to summary

PumpStreamHandler	back to summary
public PumpStreamHandler(OutputStream out, OutputStream err) Construct a new `PumpStreamHandler`. Parameters out:OutputStream the output `OutputStream`, must not be null. err:OutputStream the error `OutputStream`, must not be null.

public PumpStreamHandler(OutputStream out, OutputStream err)

Construct a new PumpStreamHandler.

Parameters

out:OutputStream: the output OutputStream, must not be null.
err:OutputStream: the error OutputStream, must not be null.

PumpStreamHandler back to summary

PumpStreamHandler	back to summary
public PumpStreamHandler(OutputStream outAndErr) Construct a new `PumpStreamHandler`. Parameters outAndErr:OutputStream the output/error `OutputStream`, must not be null.

public PumpStreamHandler(OutputStream outAndErr)

Construct a new PumpStreamHandler.

Parameters

outAndErr:OutputStream: the output/error OutputStream, must not be null.

PumpStreamHandler	back to summary
public PumpStreamHandler() Construct a new `PumpStreamHandler`.

Method Detail

createProcessErrorPump	back to summary
protected void createProcessErrorPump(InputStream is, OutputStream os) Create the pump to handle error output. Parameters is:InputStream the input stream to copy from. os:OutputStream the output stream to copy to.

createProcessErrorPump

back to summary

protected void createProcessErrorPump(InputStream is, OutputStream os)

Create the pump to handle error output.

Parameters

is:InputStream: the input stream to copy from.
os:OutputStream: the output stream to copy to.

createProcessOutputPump back to summary

createProcessOutputPump	back to summary
protected void createProcessOutputPump(InputStream is, OutputStream os) Create the pump to handle process output. Parameters is:InputStream the `InputStream`. os:OutputStream the `OutputStream`.

protected void createProcessOutputPump(InputStream is, OutputStream os)

Create the pump to handle process output.

Parameters

is:InputStream: the InputStream.
os:OutputStream: the OutputStream.

createPump	back to summary
protected Thread createPump(InputStream is, OutputStream os) Creates a stream pumper to copy the given input stream to the given output stream. Parameters is:InputStream the input stream to copy from. os:OutputStream the output stream to copy to. Returns:Thread a thread object that does the pumping.

createPump

back to summary

protected Thread createPump(InputStream is, OutputStream os)

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

Parameters

is:InputStream: the input stream to copy from.
os:OutputStream: the output stream to copy to.

Returns:Thread

a thread object that does the pumping.

createPump back to summary

createPump	back to summary
protected Thread createPump(InputStream is, OutputStream os, boolean closeWhenExhausted) Creates a stream pumper to copy the given input stream to the given output stream. Parameters is:InputStream the input stream to copy from. os:OutputStream the output stream to copy to. closeWhenExhausted:boolean if true close the inputstream. Returns:Thread a thread object that does the pumping, subclasses should return an instance of `ThreadWithPumper`.

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

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

Parameters

is:InputStream: the input stream to copy from.
os:OutputStream: the output stream to copy to.
closeWhenExhausted:boolean: if true close the inputstream.

Returns:Thread

a thread object that does the pumping, subclasses should return an instance of ThreadWithPumper.

createPump back to summary

createPump	back to summary
protected Thread createPump(InputStream is, OutputStream os, boolean closeWhenExhausted, boolean nonBlockingIO) Creates a stream pumper to copy the given input stream to the given output stream. Parameters is:InputStream the input stream to copy from. os:OutputStream the output stream to copy to. closeWhenExhausted:boolean if true close the inputstream. nonBlockingIO:boolean set it to `true` to use simulated non blocking IO. Returns:Thread a thread object that does the pumping, subclasses should return an instance of `ThreadWithPumper`. Since Ant 1.8.2

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

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

Parameters

is:InputStream: the input stream to copy from.
os:OutputStream: the output stream to copy to.
closeWhenExhausted:boolean: if true close the inputstream.
nonBlockingIO:boolean: set it to true to use simulated non blocking IO.

Returns:Thread

a thread object that does the pumping, subclasses should return an instance of ThreadWithPumper.

Since

Ant 1.8.2

finish back to summary

finish	back to summary
protected final void finish(Thread t) Waits for a thread to finish while trying to make it finish quicker by stopping the pumper (if the thread is a `ThreadWithPumper` instance) or interrupting the thread. Parameters t:Thread Thread Since Ant 1.8.0

protected final void finish(Thread t)

Waits for a thread to finish while trying to make it finish quicker by stopping the pumper (if the thread is a ThreadWithPumper instance) or interrupting the thread.

Parameters

t:Thread: Thread

Since

Ant 1.8.0

getErr back to summary

getErr	back to summary
protected OutputStream getErr() Get the error stream. Returns:OutputStream `OutputStream`.

protected OutputStream getErr()

Get the error stream.

Returns:OutputStream: OutputStream.

getOut back to summary

getOut	back to summary
protected OutputStream getOut() Get the output stream. Returns:OutputStream `OutputStream`.

protected OutputStream getOut()

Get the output stream.

Returns:OutputStream: OutputStream.

setProcessErrorStream back to summary

setProcessErrorStream	back to summary
public void setProcessErrorStream(InputStream is) Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessErrorStream. Set the `InputStream` from which to read the standard error of the process. Parameters is:InputStream the `InputStream`.

public void setProcessErrorStream(InputStream is)

Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessErrorStream.

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

Parameters

is:InputStream: the InputStream.

setProcessInputStream back to summary

setProcessInputStream	back to summary
public void setProcessInputStream(OutputStream os) Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessInputStream. Set the `OutputStream` by means of which input can be sent to the process. Parameters os:OutputStream the `OutputStream`.

public void setProcessInputStream(OutputStream os)

Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessInputStream.

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

Parameters

os:OutputStream: the OutputStream.

setProcessOutputStream back to summary

setProcessOutputStream	back to summary
public void setProcessOutputStream(InputStream is) Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessOutputStream. Set the `InputStream` from which to read the standard output of the process. Parameters is:InputStream the `InputStream`.

public void setProcessOutputStream(InputStream is)

Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.setProcessOutputStream.

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

Parameters

is:InputStream: the InputStream.

start back to summary

start	back to summary
public void start() Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.start. Start the `Thread`s.

public void start()

Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.start.

Start the Threads.

start	back to summary
private void start(Thread t)

stop	back to summary
public void stop() Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.stop. Stop pumping the streams.

stop

back to summary

public void stop()

Implements org.apache.tools.ant.taskdefs.ExecuteStreamHandler.stop.

Stop pumping the streams.

public Class PumpStreamHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class PumpStreamHandler.ThreadWithPumper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail