org.apache.tools.ant.filters

Class ConcatFilter

public final class ConcatFilter extends BaseParamFilterReader implements ChainableReader

Concats a file before and/or after the file.

Example:

 
     
     
         
     
 
 
Copies all java sources from src to build and adds the content of apache-license-java.txt add the beginning of each file.

Since: 1.6

Version: 2003-09-23

Constructor Summary
ConcatFilter()
Constructor for "dummy" instances.
ConcatFilter(Reader in)
Creates a new filtered reader.
Method Summary
Readerchain(Reader rdr)
Creates a new ConcatReader using the passed in Reader for instantiation.
FilegetAppend()
Returns append attribute.
FilegetPrepend()
Returns prepend attribute.
intread()
Returns the next character in the filtered stream.
voidsetAppend(File append)
Sets append attribute.
voidsetPrepend(File prepend)
Sets prepend attribute.

Constructor Detail

ConcatFilter

public ConcatFilter()
Constructor for "dummy" instances.

See Also: BaseFilterReader

ConcatFilter

public ConcatFilter(Reader in)
Creates a new filtered reader.

Parameters: in A Reader object providing the underlying stream. Must not be null.

Method Detail

chain

public Reader chain(Reader rdr)
Creates a new ConcatReader using the passed in Reader for instantiation.

Parameters: rdr A Reader object providing the underlying stream. Must not be null.

Returns: a new filter based on this configuration, but filtering the specified reader

getAppend

public File getAppend()
Returns append attribute.

Returns: append attribute

getPrepend

public File getPrepend()
Returns prepend attribute.

Returns: prepend attribute

read

public int read()
Returns the next character in the filtered stream. If the desired number of lines have already been read, the resulting stream is effectively at an end. Otherwise, the next character from the underlying stream is read and returned.

Returns: the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Throws: IOException if the underlying stream throws an IOException during reading

setAppend

public void setAppend(File append)
Sets append attribute.

Parameters: append new value

setPrepend

public void setPrepend(File prepend)
Sets prepend attribute.

Parameters: prepend new value