Modifier and Type	Class and Description
pack-priv class	StreamPumper.PostStopHandle A handle that can be used after `stop()` has been invoked to check if the `StreamPumper` is in the process of do some post-stop tasks (like flushing of streams), before finishing.

Field Summary

Modifier and Type	Field and Description
private volatile boolean	askedToStop
private boolean	autoflush
private int	bufferSize
private final boolean	closeWhenExhausted
private Exception	exception
private volatile boolean	finished
private final InputStream	is
private final OutputStream	os
private static final long	POLL_INTERVAL
private StreamPumper.PostStopHandle	postStopHandle
private static final int	SMALL_BUFFER_SIZE
private boolean	started
private final boolean	useAvailable

Constructor Summary

Access	Constructor and Description
public	StreamPumper(InputStream input stream to read data from is, OutputStream output stream to write data to. os, boolean if true, the output stream will be closed when the input is exhausted. closeWhenExhausted) Create a new StreamPumper.
public	StreamPumper(InputStream input stream to read data from is, OutputStream output stream to write data to. os, boolean if true, the output stream will be closed when the input is exhausted. closeWhenExhausted, boolean whether the pumper should use `available` to determine whether input is ready, thus trying to emulate non-blocking behavior. useAvailable) Create a new StreamPumper.
public	StreamPumper(InputStream input stream to read data from is, OutputStream output stream to write data to. os) Create a new StreamPumper.

Method Summary

Modifier and Type	Method and Description
private void	doPostStop()
public synchronized int	Returns: the int size of the read buffer. getBufferSize() Get the size in bytes of the read buffer.
public synchronized Exception	Returns: the Exception encountered. getException() Get the exception encountered, if any.
public boolean	Returns: true is the stream has been exhausted. isFinished() Tells whether the end of the stream has been reached.
public void	run() Implements java.lang.Runnable.run. Copies data from the input stream to the output stream.
pack-priv void	setAutoflush(boolean if true, push through data; if false, let it be buffered autoflush) Set whether data should be flushed through to the output stream.
public synchronized void	setBufferSize(int the buffer size to use. bufferSize) Set the size in bytes of the read buffer.
pack-priv synchronized StreamPumper.PostStopHandle	Returns: Returns a `PostStopHandle` for the callers to know if the status of post-stop activities, that happen, before this `StreamPumper` is actually finished stop() Stop the pumper as soon as possible.
public synchronized void	waitFor() This method blocks until the StreamPumper finishes.
private void	waitForInput(InputStream is)

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

Field Detail

askedToStop	back to summary
private volatile boolean askedToStop

autoflush	back to summary
private boolean autoflush

bufferSize	back to summary
private int bufferSize

closeWhenExhausted	back to summary
private final boolean closeWhenExhausted

exception	back to summary
private Exception exception

finished	back to summary
private volatile boolean finished

is	back to summary
private final InputStream is

os	back to summary
private final OutputStream os

POLL_INTERVAL	back to summary
private static final long POLL_INTERVAL

postStopHandle	back to summary
private StreamPumper.PostStopHandle postStopHandle

SMALL_BUFFER_SIZE	back to summary
private static final int SMALL_BUFFER_SIZE

started	back to summary
private boolean started

useAvailable	back to summary
private final boolean useAvailable

Constructor Detail

StreamPumper	back to summary
public StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted) Create a new StreamPumper. Parameters is:InputStream input stream to read data from os:OutputStream output stream to write data to. closeWhenExhausted:boolean if true, the output stream will be closed when the input is exhausted.

StreamPumper

back to summary

public StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted)

Create a new StreamPumper.

Parameters

is:InputStream: input stream to read data from
os:OutputStream: output stream to write data to.
closeWhenExhausted:boolean: if true, the output stream will be closed when the input is exhausted.

StreamPumper back to summary

StreamPumper	back to summary
public StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted, boolean useAvailable) Create a new StreamPumper. Note If you set useAvailable to true, you must explicitly invoke `stop` or interrupt the corresponding Thread when you are done or the run method will never finish on some JVMs (namely those where available returns 0 on a closed stream). Setting it to true may also impact performance negatively. This flag should only be set to true if you intend to stop the pumper before the input stream gets closed. Parameters is:InputStream input stream to read data from os:OutputStream output stream to write data to. closeWhenExhausted:boolean if true, the output stream will be closed when the input is exhausted. useAvailable:boolean whether the pumper should use `available` to determine whether input is ready, thus trying to emulate non-blocking behavior. Since Ant 1.8.0

public StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted, boolean useAvailable)

Create a new StreamPumper.

Note

If you set useAvailable to true, you must explicitly invoke stop or interrupt the corresponding Thread when you are done or the run method will never finish on some JVMs (namely those where available returns 0 on a closed stream). Setting it to true may also impact performance negatively. This flag should only be set to true if you intend to stop the pumper before the input stream gets closed.

Parameters

is:InputStream: input stream to read data from
os:OutputStream: output stream to write data to.
closeWhenExhausted:boolean: if true, the output stream will be closed when the input is exhausted.
useAvailable:boolean: whether the pumper should use available to determine whether input is ready, thus trying to emulate non-blocking behavior.

Since

Ant 1.8.0

StreamPumper	back to summary
public StreamPumper(InputStream is, OutputStream os) Create a new StreamPumper. Parameters is:InputStream input stream to read data from os:OutputStream output stream to write data to.

StreamPumper

back to summary

public StreamPumper(InputStream is, OutputStream os)

Create a new StreamPumper.

Parameters

is:InputStream: input stream to read data from
os:OutputStream: output stream to write data to.

Method Detail

doPostStop	back to summary
private void doPostStop() throws IOException

getBufferSize	back to summary
public synchronized int getBufferSize() Get the size in bytes of the read buffer. Returns:int the int size of the read buffer.

getBufferSize

back to summary

public synchronized int getBufferSize()

Get the size in bytes of the read buffer.

Returns:int: the int size of the read buffer.

getException	back to summary
public synchronized Exception getException() Get the exception encountered, if any. Returns:Exception the Exception encountered.

getException

back to summary

public synchronized Exception getException()

Get the exception encountered, if any.

Returns:Exception: the Exception encountered.

isFinished	back to summary
public boolean isFinished() Tells whether the end of the stream has been reached. Returns:boolean true is the stream has been exhausted.

isFinished

back to summary

public boolean isFinished()

Tells whether the end of the stream has been reached.

Returns:boolean: true is the stream has been exhausted.

run	back to summary
public void run() Implements java.lang.Runnable.run. Copies data from the input stream to the output stream. Terminates as soon as the input stream is closed or an error occurs. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Copies data from the input stream to the output stream. Terminates as soon as the input stream is closed or an error occurs.

Annotations

@Override

setAutoflush	back to summary
pack-priv void setAutoflush(boolean autoflush) Set whether data should be flushed through to the output stream. Parameters autoflush:boolean if true, push through data; if false, let it be buffered Since Ant 1.6.3

setAutoflush

back to summary

pack-priv void setAutoflush(boolean autoflush)

Set whether data should be flushed through to the output stream.

Parameters

autoflush:boolean: if true, push through data; if false, let it be buffered

Since

Ant 1.6.3

setBufferSize	back to summary
public synchronized void setBufferSize(int bufferSize) Set the size in bytes of the read buffer. Parameters bufferSize:int the buffer size to use. Exceptions IllegalStateException: if the StreamPumper is already running.

setBufferSize

back to summary

public synchronized void setBufferSize(int bufferSize)

Set the size in bytes of the read buffer.

Parameters

bufferSize:int: the buffer size to use.

Exceptions

IllegalStateException:: if the StreamPumper is already running.

stop back to summary

stop	back to summary
pack-priv synchronized StreamPumper.PostStopHandle stop() Stop the pumper as soon as possible. Note that it may continue to block on the input stream but it will really stop the thread as soon as it gets EOF or any byte, and it will be marked as finished. Returns:StreamPumper.PostStopHandle Returns a `PostStopHandle` for the callers to know if the status of post-stop activities, that happen, before this `StreamPumper` is actually finished Since Ant 1.6.3, Ant 10.2.0 this method returns a `PostStopHandle`

pack-priv synchronized StreamPumper.PostStopHandle stop()

Stop the pumper as soon as possible. Note that it may continue to block on the input stream but it will really stop the thread as soon as it gets EOF or any byte, and it will be marked as finished.

Returns:StreamPumper.PostStopHandle: Returns a PostStopHandle for the callers to know if the status of post-stop activities, that happen, before this StreamPumper is actually finished
Since: Ant 1.6.3, Ant 10.2.0 this method returns a PostStopHandle

waitFor back to summary

waitFor	back to summary
public synchronized void waitFor() throws InterruptedException This method blocks until the StreamPumper finishes. Exceptions InterruptedException: if interrupted. See Also `isFinished()`

public synchronized void waitFor() throws InterruptedException

This method blocks until the StreamPumper finishes.

Exceptions

InterruptedException:: if interrupted.

See Also

isFinished()

waitForInput	back to summary
private void waitForInput(InputStream is) throws IOException, InterruptedException

org.apache.tools.ant.taskdefs back to summary

pack-priv final Class StreamPumper.PostStopHandle

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.taskdefs.StreamPumper.PostStopHandle

A handle that can be used after stop() has been invoked to check if the StreamPumper is in the process of do some post-stop tasks (like flushing of streams), before finishing.

Field Summary

Modifier and Type	Field and Description
private boolean	inPostStopTasks
private final CountDownLatch	latch

Constructor Summary

Access	Constructor and Description
pack-priv	PostStopHandle()

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	Returns: Returns true if the post-stop activities completed within the specified `timeout`. Else returns false awaitPostStopCompletion(final long The maximum amount of time to wait for the post-stop activities to complete timeout, final TimeUnit The unit of `timeout` timeUnit) Waits for a maximum of `timeout` time for the post-stop activities to complete.
pack-priv boolean	isInPostStopTasks() Returns true if the `StreamPumper` is doing post-stop tasks (like flushing of streams).

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

Field Detail

inPostStopTasks	back to summary
private boolean inPostStopTasks

latch	back to summary
private final CountDownLatch latch

Constructor Detail

PostStopHandle	back to summary
pack-priv PostStopHandle()

Method Detail

awaitPostStopCompletion back to summary

awaitPostStopCompletion	back to summary
pack-priv boolean awaitPostStopCompletion(final long timeout, final TimeUnit timeUnit) throws InterruptedException Waits for a maximum of `timeout` time for the post-stop activities to complete. Parameters timeout:long The maximum amount of time to wait for the post-stop activities to complete timeUnit:TimeUnit The unit of `timeout` Returns:boolean Returns true if the post-stop activities completed within the specified `timeout`. Else returns false Exceptions InterruptedException: If the current thread was interrupted while waiting

pack-priv boolean awaitPostStopCompletion(final long timeout, final TimeUnit timeUnit) throws InterruptedException

Waits for a maximum of timeout time for the post-stop activities to complete.

Parameters

timeout:long: The maximum amount of time to wait for the post-stop activities to complete
timeUnit:TimeUnit: The unit of timeout

Returns:boolean

Returns true if the post-stop activities completed within the specified timeout. Else returns false

Exceptions

InterruptedException:: If the current thread was interrupted while waiting

isInPostStopTasks	back to summary
pack-priv boolean isInPostStopTasks() Returns true if the `StreamPumper` is doing post-stop tasks (like flushing of streams). Else returns false.

public Class StreamPumper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class StreamPumper.PostStopHandle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail