Package org.apache.tools.ant.util
Class OutputStreamFunneler
- java.lang.Object
-
- org.apache.tools.ant.util.OutputStreamFunneler
-
public class OutputStreamFunneler extends java.lang.ObjectManages a set ofOutputStreams to write to a single underlying stream, which is closed only when the last "funnel" has been closed.
-
-
Field Summary
Fields Modifier and Type Field Description static longDEFAULT_TIMEOUT_MILLISDefault timeout.
-
Constructor Summary
Constructors Constructor Description OutputStreamFunneler(java.io.OutputStream out)Create a newOutputStreamFunnelerfor the specifiedOutputStream.OutputStreamFunneler(java.io.OutputStream out, long timeoutMillis)Create a newOutputStreamFunnelerfor the specifiedOutputStream, with the specified timeout value.
-
Method Summary
Modifier and Type Method Description java.io.OutputStreamgetFunnelInstance()Get a "funnel"OutputStreaminstance to write to thisOutputStreamFunneler's underlyingOutputStream.voidsetTimeout(long timeoutMillis)Set the timeout for thisOutputStreamFunneler.
-
-
-
Field Detail
-
DEFAULT_TIMEOUT_MILLIS
public static final long DEFAULT_TIMEOUT_MILLIS
Default timeout.- See Also:
setTimeout(long), Constant Field Values
-
-
Constructor Detail
-
OutputStreamFunneler
public OutputStreamFunneler(java.io.OutputStream out)
Create a newOutputStreamFunnelerfor the specifiedOutputStream.- Parameters:
out-OutputStream.
-
OutputStreamFunneler
public OutputStreamFunneler(java.io.OutputStream out, long timeoutMillis)Create a newOutputStreamFunnelerfor the specifiedOutputStream, with the specified timeout value.- Parameters:
out-OutputStream.timeoutMillis-long.- See Also:
setTimeout(long)
-
-
Method Detail
-
setTimeout
public void setTimeout(long timeoutMillis)
Set the timeout for thisOutputStreamFunneler. This is the maximum time that may elapse between the closure of the last "funnel" and the next call togetOutputStream()without closing the underlying stream.- Parameters:
timeoutMillis-longtimeout value.
-
getFunnelInstance
public java.io.OutputStream getFunnelInstance() throws java.io.IOExceptionGet a "funnel"OutputStreaminstance to write to thisOutputStreamFunneler's underlyingOutputStream.- Returns:
OutputStream.- Throws:
java.io.IOException- if unable to create the funnel.
-
-