Class ConcatFilter

java.lang.Object

java.io.Reader

java.io.FilterReader

org.apache.tools.ant.filters.BaseFilterReader

org.apache.tools.ant.filters.BaseParamFilterReader

org.apache.tools.ant.filters.ConcatFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Readable, ChainableReader, Parameterizable

public final class ConcatFilter
extends BaseParamFilterReader
implements ChainableReader

Concats a file before and/or after the file.

Example:

<copy todir="build">
    <fileset dir="src" includes="*.java"/>
    <filterchain>
        <concatfilter prepend="apache-license-java.txt"/>
    </filterchain>
</copy>

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

Field Summary

Fields inherited from class FilterReader

in

Fields inherited from class Reader

lock

Constructor Summary

Constructors

Constructor	Description
ConcatFilter()	Constructor for "dummy" instances.
ConcatFilter(Reader in)	Creates a new filtered reader.

Method Summary

Modifier and Type	Method	Description
Reader	chain(Reader rdr)	Creates a new ConcatReader using the passed in Reader for instantiation.
File	getAppend()	Returns append attribute.
File	getPrepend()	Returns prepend attribute.
int	read()	Returns the next character in the filtered stream.
void	setAppend(File append)	Sets append attribute.
void	setPrepend(File prepend)	Sets prepend attribute.

Methods inherited from class BaseParamFilterReader

getParameters, setParameters

Modifier and Type	Method	Description
protected final Parameter[]	getParameters()	Returns the parameters to be used by this filter.
final void	setParameters(Parameter... parameters)	Sets the parameters used by this filter, and sets the filter to an uninitialized status.

Methods inherited from class BaseFilterReader

getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip

Modifier and Type	Method	Description
protected final boolean	getInitialized()	Returns the initialized status.
protected final Project	getProject()	Returns the project this filter is part of.
final int	read(char[] cbuf, int off, int len)	Reads characters into a portion of an array.
protected final String	readFully()	Reads to the end of the stream, returning the contents as a String.
protected final String	readLine()	Reads a line of text ending with '\n' (or until the end of the stream).
protected final void	setInitialized(boolean initialized)	Sets the initialized status.
final void	setProject(Project project)	Sets the project to work with.
final long	skip(long n)	Skips characters.

Methods inherited from class FilterReader

close, mark, markSupported, ready, reset

Methods inherited from class Reader

nullReader, of, read, read, readAllAsString, readAllLines, transferTo

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

read

public int read()
         throws IOException

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.

Overrides:

read in class FilterReader

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

setPrepend

public void setPrepend(File prepend)

Sets prepend attribute.

Parameters:

prepend - new value

getPrepend

public File getPrepend()

Returns prepend attribute.

Returns:

prepend attribute

setAppend

public void setAppend(File append)

Sets append attribute.

Parameters:

append - new value

getAppend

public File getAppend()

Returns append attribute.

Returns:

append attribute

chain

public Reader chain(Reader rdr)

Creates a new ConcatReader using the passed in Reader for instantiation.

Specified by:

chain in interface ChainableReader

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