org.apache.tools.ant.taskdefs

Class Concat

public class Concat extends Task implements ResourceCollection

This class contains the 'concat' task, used to concatenate a series of files into a single stream. The destination of this stream may be the system console, or a file. The following is a sample invocation:

 <concat destfile="${build.dir}/index.xml"
   append="false">

   <fileset dir="${xml.root.dir}"
     includes="*.xml" />

 </concat>

Nested Class Summary
static class	Concat.TextElement sub element points to a file or contains text

Constructor Summary
	Concat() Construct a new Concat task.

Method Summary
void	add(ResourceCollection c) Add an arbitrary ResourceCollection.
void	addFilelist(FileList list) List of files to concatenate.
void	addFileset(FileSet set) Set of files to concatenate.
void	addFilterChain(FilterChain filterChain) Adds a FilterChain.
void	addFooter(Concat.TextElement footerToAdd) Add a footer to the concatenated output
void	addHeader(Concat.TextElement headerToAdd) Add a header to the concatenated output
void	addText(String text) This method adds text which appears in the 'concat' element.
Path	createPath() Path of files to concatenate.
void	execute() Execute the concat task.
boolean	isFilesystemOnly() Implement ResourceCollection.
Iterator	iterator() Implement ResourceCollection.
void	reset() Reset state to default.
void	setAppend(boolean append) Sets the behavior when the destination file exists.
void	setBinary(boolean binary) Set the binary attribute.
void	setDestfile(File destinationFile) Sets the destination file, or uses the console if not specified.
void	setEncoding(String encoding) Sets the character encoding
void	setEol(FixCRLF.CrLf crlf) Specify the end of line to find and to add if not present at end of each input file.
void	setFixLastLine(boolean fixLastLine) Append line.separator to files that do not end with a line.separator, default false.
void	setForce(boolean force) Force overwrite existing destination file
void	setOutputEncoding(String outputEncoding) Sets the character encoding for outputting
void	setWriter(Writer outputWriter) Set the output writer.
int	size() Implement ResourceCollection.

Constructor Detail

Concat

public Concat()

Construct a new Concat task.

Method Detail

add

public void add(ResourceCollection c)

Add an arbitrary ResourceCollection.

Parameters: c the ResourceCollection to add.

Since: Ant 1.7

addFilelist

public void addFilelist(FileList list)

List of files to concatenate.

Parameters: list the list of files

addFileset

public void addFileset(FileSet set)

Set of files to concatenate.

Parameters: set the set of files

addFilterChain

public void addFilterChain(FilterChain filterChain)

Adds a FilterChain.

Parameters: filterChain a filterchain to filter the concatenated input

Since: Ant 1.6

addFooter

public void addFooter(Concat.TextElement footerToAdd)

Add a footer to the concatenated output

Parameters: footerToAdd the footer

Since: Ant 1.6

addHeader

public void addHeader(Concat.TextElement headerToAdd)

Add a header to the concatenated output

Parameters: headerToAdd the header

Since: Ant 1.6

addText

public void addText(String text)

This method adds text which appears in the 'concat' element.

Parameters: text the text to be concated.

createPath

public Path createPath()

Path of files to concatenate.

Returns: the path used for concatenating

Since: Ant 1.6

execute

public void execute()

Execute the concat task.

isFilesystemOnly

public boolean isFilesystemOnly()

Implement ResourceCollection.

Returns: false.

iterator

public Iterator iterator()

Implement ResourceCollection.

Returns: Iterator.

reset

public void reset()

Reset state to default.

setAppend

public void setAppend(boolean append)

Sets the behavior when the destination file exists. If set to true the stream data will be appended to the existing file, otherwise the existing file will be overwritten. Defaults to false.

Parameters: append if true append to the file.

setBinary

public void setBinary(boolean binary)

Set the binary attribute. If true, concat will concatenate the files byte for byte. This mode does not allow any filtering or other modifications to the input streams. The default value is false.

Parameters: binary if true, enable binary mode.

Since: Ant 1.6.2