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

Modifier and Type	Class and Description
private class	Redirector.PropertyOutputStream

Field Summary

Modifier and Type	Field and Description
private boolean	alwaysLogErr
private boolean	alwaysLogOut Flag which indicates that output should be always sent to the log
private boolean	appendErr
private boolean	appendOut Flag which indicates if error and output files are to be appended.
private boolean	appendProperties Whether to complete properties settings
private Redirector.PropertyOutputStream	baos Buffer used to capture output for storage into a property
private boolean	createEmptyFilesErr
private boolean	createEmptyFilesOut Flag which indicates whether files should be created even when empty.
private static final String	DEFAULT_ENCODING
private boolean	discardErr
private boolean	discardOut Flag which indicates if error and output files are to be discarded.
private final Object	errMutex Mutex for err
private File[]	error The file(s) to which standard error is being redirected
private Redirector.PropertyOutputStream	errorBaos Buffer used to capture error output for storage into a property
private String	errorEncoding The error encoding
private Vector<FilterChain>	errorFilterChains The error filter chains
private PrintStream	errorPrintStream Stream which is used for line oriented error output
private String	errorProperty The name of the property into which error output is to be stored
private OutputStream	errorStream The stream for error output
private final Object	inMutex Mutex for in
private File[]	input The file(s) from which standard input is being taken.
private String	inputEncoding The input encoding
private Vector<FilterChain>	inputFilterChains The input filter chains
private InputStream	inputStream The stream for input
private String	inputString String from which input is taken
private boolean	logError Indicates if standard error should be logged to Ant's log system rather than the output.
private boolean	logInputString whether to log the inputstring
private final ProjectComponent	managingTask The task for which this redirector is working
private File[]	out The file(s) receiving standard output.
private final Object	outMutex Mutex for out
private PrintStream	outPrintStream Stream which is used for line oriented output
private String	outputEncoding The output encoding
private Vector<FilterChain>	outputFilterChains The output filter chains
private boolean	outputIsBinary Is the output binary or can we safely split it into lines?
private String	outputProperty The name of the property into which output is to be stored
private OutputStream	outputStream The stream for output data
private static final int	STREAMPUMPER_WAIT_INTERVAL
private final ThreadGroup	threadGroup The thread group used for starting `StreamPumper` threads

Constructor Summary

Access	Constructor and Description
public	Redirector(final Task the task for which the redirector is to work managingTask) Create a redirector instance for the given task
public	Redirector(final ProjectComponent the project component for which the redirector is to work managingTask) Create a redirector instance for the given task

Method Summary

Modifier and Type	Method and Description
public void	complete() Complete redirection.
public ExecuteStreamHandler	Returns: the execute stream handler to manage the input, output and error streams. createHandler() Create the StreamHandler to use with our Execute instance.
public void	createStreams() Create the input, error and output streams based on the configuration options.
private void	errorStreams()
private OutputStream	foldFiles(final File[] file, final String logHead, final int loglevel, final boolean append, final boolean createEmptyFiles)
public OutputStream	Returns: the redirector's error stream or null if no output has been configured getErrorStream() Get the error stream for the redirector
public InputStream	Returns: the redirector's input stream or null if no output has been configured getInputStream() Get the input stream for the redirector
public OutputStream	Returns: the redirector's output stream or null if no output has been configured getOutputStream() Get the output stream for the redirector
protected void	handleErrorFlush(final String the error information being flushed. output) Handle a flush operation on the error stream
protected void	handleErrorOutput(final String the error output data. output) Process error output
protected void	handleFlush(final String the data being flushed. output) Process data due to a flush operation.
protected int	Returns: the number of bytes read handleInput(final byte[] the buffer into which data is to be read. buffer, final int the offset into the buffer at which data is stored. offset, final int the amount of data to read length) Handle an input request
protected void	handleOutput(final String the data to be output output) Pass output sent to System.out to specified output.
private void	outStreams() outStreams
public void	setAlwaysLog(final boolean `boolean` alwaysLog) If true, (error and non-error) output will be "teed", redirected as specified while being sent to Ant's logging mechanism as if no redirection had taken place.
public void	setAppend(final boolean if true output and error streams are appended to their respective files, if specified. append) Whether output should be appended to or overwrite an existing file.
public void	setAppendProperties(final boolean whether to append properties. appendProperties) This `Redirector`'s subordinate `PropertyOutputStream`s will not set their respective properties `while (appendProperties && append)`.
public void	setBinaryOutput(final boolean boolean b) Whether to consider the output created by the process binary.
public void	setCreateEmptyFiles(final boolean `boolean`. createEmptyFiles) Whether output and error files should be created even when empty.
public void	setDiscardError(final boolean if true error streams are discarded. discard) Whether error output should be discarded.
public void	setDiscardOutput(final boolean if true output streams are discarded. discard) Whether output should be discarded.
public void	setError(final File the file to which error is to be written error) Set the file to which standard error is to be redirected.
public void	setError(final File[] the file to which error is to be written error) Set the files to which standard error is to be redirected.
public void	setErrorEncoding(final String `String`. errorEncoding) Set the error encoding.
public void	setErrorFilterChains(final Vector<FilterChain> `Vector` containing `FilterChain`. errorFilterChains) Set the error `FilterChain`s.
public void	setErrorProperty(final String the name of the property to be set with the error output. errorProperty) Property name whose value should be set to the error of the process.
public void	setInput(final File the file from which input is read. input) Set the input to use for the task
public void	setInput(final File[] the files from which input is read. input) Set the input to use for the task
public void	setInputEncoding(final String `String`. inputEncoding) Set the input encoding.
public void	setInputFilterChains(final Vector<FilterChain> `Vector` containing `FilterChain`. inputFilterChains) Set the input `FilterChain`s.
pack-priv void	setInputStream(final InputStream the stream from which input will be read inputStream) Set a stream to use as input.
public void	setInputString(final String the string which is used as the input source inputString) Set the string to use as input
public void	setLogError(final boolean if true the standard error is sent to the Ant log system and not sent to output. logError) Controls whether error output of exec is logged.
public void	setLogInputString(final boolean true or false. logInputString) Set whether to include the value of the input string in log messages.
public void	setOutput(final File the file to which output stream is written out) File the output of the process is redirected to.
public void	setOutput(final File[] the files to which output stream is written out) Files the output of the process is redirected to.
public void	setOutputEncoding(final String `String`. outputEncoding) Set the output encoding.
public void	setOutputFilterChains(final Vector<FilterChain> `Vector` containing `FilterChain`. outputFilterChains) Set the output `FilterChain`s.
public void	setOutputProperty(final String the name of the property to be set with the task's output. outputProperty) Property name whose value should be set to the output of the process.
public void	setProperties() Notify the `Redirector` that it is now okay to set any output and/or error properties.
private void	setPropertyFromBAOS(final ByteArrayOutputStream contains the property value. baos, final String the property name. propertyName) Set a property from a ByteArrayOutputStream

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

Field Detail

alwaysLogErr	back to summary
private boolean alwaysLogErr

alwaysLogOut	back to summary
private boolean alwaysLogOut Flag which indicates that output should be always sent to the log

appendErr	back to summary
private boolean appendErr

appendOut	back to summary
private boolean appendOut Flag which indicates if error and output files are to be appended.

appendProperties	back to summary
private boolean appendProperties Whether to complete properties settings

baos	back to summary
private Redirector.PropertyOutputStream baos Buffer used to capture output for storage into a property

createEmptyFilesErr	back to summary
private boolean createEmptyFilesErr

createEmptyFilesOut	back to summary
private boolean createEmptyFilesOut Flag which indicates whether files should be created even when empty.

DEFAULT_ENCODING	back to summary
private static final String DEFAULT_ENCODING

discardErr	back to summary
private boolean discardErr

discardOut	back to summary
private boolean discardOut Flag which indicates if error and output files are to be discarded.

errMutex	back to summary
private final Object errMutex Mutex for err

error	back to summary
private File[] error The file(s) to which standard error is being redirected

errorBaos	back to summary
private Redirector.PropertyOutputStream errorBaos Buffer used to capture error output for storage into a property

errorEncoding	back to summary
private String errorEncoding The error encoding

errorFilterChains	back to summary
private Vector<FilterChain> errorFilterChains The error filter chains

errorPrintStream	back to summary
private PrintStream errorPrintStream Stream which is used for line oriented error output

errorProperty	back to summary
private String errorProperty The name of the property into which error output is to be stored

errorStream	back to summary
private OutputStream errorStream The stream for error output

inMutex	back to summary
private final Object inMutex Mutex for in

input	back to summary
private File[] input The file(s) from which standard input is being taken. If > 1, files' content will be concatenated in the order received.

inputEncoding	back to summary
private String inputEncoding The input encoding

inputFilterChains	back to summary
private Vector<FilterChain> inputFilterChains The input filter chains

inputStream	back to summary
private InputStream inputStream The stream for input

inputString	back to summary
private String inputString String from which input is taken

logError	back to summary
private boolean logError Indicates if standard error should be logged to Ant's log system rather than the output. This has no effect if standard error is redirected to a file or property.

logInputString	back to summary
private boolean logInputString whether to log the inputstring

managingTask	back to summary
private final ProjectComponent managingTask The task for which this redirector is working

out	back to summary
private File[] out The file(s) receiving standard output. Will also receive standard error unless standard error is redirected or logError is true.

outMutex	back to summary
private final Object outMutex Mutex for out

outPrintStream	back to summary
private PrintStream outPrintStream Stream which is used for line oriented output

outputEncoding	back to summary
private String outputEncoding The output encoding

outputFilterChains	back to summary
private Vector<FilterChain> outputFilterChains The output filter chains

outputIsBinary	back to summary
private boolean outputIsBinary Is the output binary or can we safely split it into lines?

outputProperty	back to summary
private String outputProperty The name of the property into which output is to be stored

outputStream	back to summary
private OutputStream outputStream The stream for output data

STREAMPUMPER_WAIT_INTERVAL	back to summary
private static final int STREAMPUMPER_WAIT_INTERVAL

threadGroup	back to summary
private final ThreadGroup threadGroup The thread group used for starting `StreamPumper` threads

Constructor Detail

Redirector	back to summary
public Redirector(final Task managingTask) Create a redirector instance for the given task Parameters managingTask:Task the task for which the redirector is to work

Redirector

back to summary

public Redirector(final Task managingTask)

Create a redirector instance for the given task

Parameters

managingTask:Task: the task for which the redirector is to work

Redirector	back to summary
public Redirector(final ProjectComponent managingTask) Create a redirector instance for the given task Parameters managingTask:ProjectComponent the project component for which the redirector is to work Since Ant 1.6.3

Redirector

back to summary

public Redirector(final ProjectComponent managingTask)

Create a redirector instance for the given task

Parameters

managingTask:ProjectComponent: the project component for which the redirector is to work

Since

Ant 1.6.3

Method Detail

complete	back to summary
public void complete() throws IOException Complete redirection. This operation will close any streams and create any specified property values. Exceptions IOException: if the output properties cannot be read from their output streams.

complete

back to summary

public void complete() throws IOException

Complete redirection. This operation will close any streams and create any specified property values.

Exceptions

IOException:: if the output properties cannot be read from their output streams.

createHandler	back to summary
public ExecuteStreamHandler createHandler() throws BuildException Create the StreamHandler to use with our Execute instance. Returns:ExecuteStreamHandler the execute stream handler to manage the input, output and error streams. Exceptions BuildException: if the execute stream handler cannot be created.

createHandler

back to summary

public ExecuteStreamHandler createHandler() throws BuildException

Create the StreamHandler to use with our Execute instance.

Returns:ExecuteStreamHandler

the execute stream handler to manage the input, output and error streams.

Exceptions

BuildException:: if the execute stream handler cannot be created.

createStreams	back to summary
public void createStreams() Create the input, error and output streams based on the configuration options.

errorStreams	back to summary
private void errorStreams()

foldFiles	back to summary
private OutputStream foldFiles(final File[] file, final String logHead, final int loglevel, final boolean append, final boolean createEmptyFiles)

getErrorStream	back to summary
public OutputStream getErrorStream() Get the error stream for the redirector Returns:OutputStream the redirector's error stream or null if no output has been configured

getErrorStream

back to summary

public OutputStream getErrorStream()

Get the error stream for the redirector

Returns:OutputStream: the redirector's error stream or null if no output has been configured

getInputStream

back to summary

public InputStream getInputStream()

Get the input stream for the redirector

Returns:InputStream: the redirector's input stream or null if no output has been configured

getOutputStream

back to summary

public OutputStream getOutputStream()

Get the output stream for the redirector

Returns:OutputStream: the redirector's output stream or null if no output has been configured

handleErrorFlush

back to summary

protected void handleErrorFlush(final String output)

Handle a flush operation on the error stream

Parameters

output:String: the error information being flushed.

handleErrorOutput

back to summary

protected void handleErrorOutput(final String output)

Process error output

Parameters

output:String: the error output data.

handleFlush

back to summary

protected void handleFlush(final String output)

Process data due to a flush operation.

Parameters

output:String: the data being flushed.

handleInput

back to summary

protected int handleInput(final byte[] buffer, final int offset, final int length) throws IOException

Handle an input request

Parameters

buffer:byte[]: the buffer into which data is to be read.
offset:int: the offset into the buffer at which data is stored.
length:int: the amount of data to read

Returns:int

the number of bytes read

Exceptions

IOException:: if the data cannot be read

handleOutput

back to summary

protected void handleOutput(final String output)

Pass output sent to System.out to specified output.

Parameters

output:String: the data to be output

outStreams	back to summary
private void outStreams() outStreams

setAlwaysLog back to summary

public void setAlwaysLog(final boolean alwaysLog)

If true, (error and non-error) output will be "teed", redirected as specified while being sent to Ant's logging mechanism as if no redirection had taken place. Defaults to false.

Parameters

alwaysLog:boolean: boolean

Since

Ant 1.6.3

setAppend

back to summary

public void setAppend(final boolean append)

Whether output should be appended to or overwrite an existing file. Defaults to false.

Parameters

append:boolean: if true output and error streams are appended to their respective files, if specified.

setAppendProperties back to summary

public void setAppendProperties(final boolean appendProperties)

This Redirector's subordinate PropertyOutputStreams will not set their respective properties while (appendProperties && append).

Parameters

appendProperties:boolean: whether to append properties.

setBinaryOutput

back to summary

public void setBinaryOutput(final boolean b)

Whether to consider the output created by the process binary.

Binary output will not be split into lines which may make error and normal output look mixed up when they get written to the same stream.

Parameters

b:boolean: boolean

Since

1.9.4

setCreateEmptyFiles back to summary

public void setCreateEmptyFiles(final boolean createEmptyFiles)

Whether output and error files should be created even when empty. Defaults to true.

Parameters

createEmptyFiles:boolean: boolean.

setDiscardError back to summary

public void setDiscardError(final boolean discard)

Whether error output should be discarded.

Defaults to false.

Parameters

discard:boolean: if true error streams are discarded.

Since

Ant 1.10.10

See Also

setDiscardOutput

setDiscardOutput back to summary

public void setDiscardOutput(final boolean discard)

Whether output should be discarded.

Defaults to false.

Parameters

discard:boolean: if true output streams are discarded.

Since

Ant 1.10.10

See Also

setDiscardError

setError

back to summary

public void setError(final File error)

Set the file to which standard error is to be redirected.

Parameters

error:File: the file to which error is to be written

setError

back to summary

public void setError(final File[] error)

Set the files to which standard error is to be redirected.

Parameters

error:File[]: the file to which error is to be written

setErrorEncoding back to summary

public void setErrorEncoding(final String errorEncoding)

Set the error encoding.

Parameters

errorEncoding:String: String.

setErrorFilterChains back to summary

public void setErrorFilterChains(final Vector<FilterChain> errorFilterChains)

Set the error FilterChains.

Parameters

errorFilterChains:Vector<FilterChain>: Vector containing FilterChain.

setErrorProperty

back to summary

public void setErrorProperty(final String errorProperty)

Property name whose value should be set to the error of the process.

Parameters

errorProperty:String: the name of the property to be set with the error output.

setInput

back to summary

public void setInput(final File input)

Set the input to use for the task

Parameters

input:File: the file from which input is read.

setInput

back to summary

public void setInput(final File[] input)

Set the input to use for the task

Parameters

input:File[]: the files from which input is read.

setInputEncoding back to summary

public void setInputEncoding(final String inputEncoding)

Set the input encoding.

Parameters

inputEncoding:String: String.

setInputFilterChains back to summary

public void setInputFilterChains(final Vector<FilterChain> inputFilterChains)

Set the input FilterChains.

Parameters

inputFilterChains:Vector<FilterChain>: Vector containing FilterChain.

setInputStream

back to summary

pack-priv void setInputStream(final InputStream inputStream)

Set a stream to use as input.

Parameters

inputStream:InputStream: the stream from which input will be read

Since

Ant 1.6.3

setInputString

back to summary

public void setInputString(final String inputString)

Set the string to use as input

Parameters

inputString:String: the string which is used as the input source

setLogError

back to summary

public void setLogError(final boolean logError)

Controls whether error output of exec is logged. This is only useful when output is being redirected and error output is desired in the Ant log

Parameters

logError:boolean: if true the standard error is sent to the Ant log system and not sent to output.

setLogInputString

back to summary

public void setLogInputString(final boolean logInputString)

Set whether to include the value of the input string in log messages. Defaults to true.

Parameters

logInputString:boolean: true or false.

Since

Ant 1.7

setOutput

back to summary

public void setOutput(final File out)

File the output of the process is redirected to. If error is not redirected, it too will appear in the output

Parameters

out:File: the file to which output stream is written

setOutput

back to summary

public void setOutput(final File[] out)

Files the output of the process is redirected to. If error is not redirected, it too will appear in the output

Parameters

out:File[]: the files to which output stream is written

setOutputEncoding back to summary

public void setOutputEncoding(final String outputEncoding)

Set the output encoding.

Parameters

outputEncoding:String: String.

setOutputFilterChains back to summary

public void setOutputFilterChains(final Vector<FilterChain> outputFilterChains)

Set the output FilterChains.

Parameters

outputFilterChains:Vector<FilterChain>: Vector containing FilterChain.

setOutputProperty

back to summary

public void setOutputProperty(final String outputProperty)

Property name whose value should be set to the output of the process.

Parameters

outputProperty:String: the name of the property to be set with the task's output.

setProperties	back to summary
public void setProperties() Notify the `Redirector` that it is now okay to set any output and/or error properties.

setPropertyFromBAOS

back to summary

private void setPropertyFromBAOS(final ByteArrayOutputStream baos, final String propertyName)

Set a property from a ByteArrayOutputStream

Parameters

baos:ByteArrayOutputStream: contains the property value.
propertyName:String: the property name.

public Class Redirector

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Redirector.PropertyOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail