Package org.apache.tools.ant.taskdefs
Class Concat
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.Concat
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Iterable<Resource>,- ResourceCollection
 
 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 SummaryNested Classes Modifier and Type Class Description static classConcat.TextElementsub element points to a file or contains text
 - 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description Concat()Construct a new Concat task.
 - 
Method SummaryModifier and Type Method Description voidadd(ResourceCollection c)Add an arbitrary ResourceCollection.voidaddFilelist(FileList list)List of files to concatenate.voidaddFileset(FileSet set)Set of files to concatenate.voidaddFilterChain(FilterChain filterChain)Adds a FilterChain.voidaddFooter(Concat.TextElement footerToAdd)Add a footer to the concatenated outputvoidaddHeader(Concat.TextElement headerToAdd)Add a header to the concatenated outputvoidaddText(java.lang.String text)This method adds text which appears in the 'concat' element.PathcreatePath()Path of files to concatenate.voidexecute()Execute the concat task.booleanisFilesystemOnly()Implement ResourceCollection.java.util.Iterator<Resource>iterator()Implement ResourceCollection.voidreset()Reset state to default.voidsetAppend(boolean append)Sets the behavior when the destination exists.voidsetBinary(boolean binary)Set the binary attribute.voidsetDest(Resource dest)Set the resource to write to.voidsetDestfile(java.io.File destinationFile)Sets the destination file, or uses the console if not specified.voidsetEncoding(java.lang.String encoding)Sets the character encodingvoidsetEol(FixCRLF.CrLf crlf)Specify the end of line to find and to add if not present at end of each input file.voidsetFixLastLine(boolean fixLastLine)Append line.separator to files that do not end with a line.separator, default false.voidsetForce(boolean forceOverwrite)Deprecated.use #setOverwrite insteadvoidsetForceReadOnly(boolean f)Whether read-only destinations will be overwritten.voidsetIgnoreEmpty(boolean ignoreEmpty)Sets the behavior when no source resource files are available.voidsetOutputEncoding(java.lang.String outputEncoding)Sets the character encoding for outputtingvoidsetOverwrite(boolean forceOverwrite)Force overwrite existing destination filevoidsetResourceName(java.lang.String resourceName)Set the name that will be reported by the exposedResource.voidsetWriter(java.io.Writer outputWriter)Set the output writer.intsize()Implement ResourceCollection.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
 
- 
 
- 
- 
- 
Method Detail- 
resetpublic void reset() Reset state to default.
 - 
setDestfilepublic void setDestfile(java.io.File destinationFile) Sets the destination file, or uses the console if not specified.- Parameters:
- destinationFile- the destination file
 
 - 
setDestpublic void setDest(Resource dest) Set the resource to write to.- Parameters:
- dest- the Resource to write to.
- Since:
- Ant 1.8
 
 - 
setAppendpublic void setAppend(boolean append) Sets the behavior when the destination exists. If set totruethe task will append the stream data anAppendableresource; otherwise existing content will be overwritten. Defaults tofalse.- Parameters:
- append- if true append output.
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) Sets the character encoding- Parameters:
- encoding- the encoding of the input stream and unless outputencoding is set, the outputstream.
 
 - 
setOutputEncodingpublic void setOutputEncoding(java.lang.String outputEncoding) Sets the character encoding for outputting- Parameters:
- outputEncoding- the encoding for the output file
- Since:
- Ant 1.6
 
 - 
setForce@Deprecated public void setForce(boolean forceOverwrite) Deprecated.use #setOverwrite insteadForce overwrite existing destination file- Parameters:
- forceOverwrite- if true always overwrite, otherwise only overwrite if the output file is older any of the input files.
- Since:
- Ant 1.6
 
 - 
setOverwritepublic void setOverwrite(boolean forceOverwrite) Force overwrite existing destination file- Parameters:
- forceOverwrite- if true always overwrite, otherwise only overwrite if the output file is older any of the input files.
- Since:
- Ant 1.8.2
 
 - 
setForceReadOnlypublic void setForceReadOnly(boolean f) Whether read-only destinations will be overwritten.Defaults to false - Parameters:
- f- boolean
- Since:
- Ant 1.8.2
 
 - 
setIgnoreEmptypublic void setIgnoreEmpty(boolean ignoreEmpty) Sets the behavior when no source resource files are available. If set tofalsethe destination file will always be created. Defaults totrue.- Parameters:
- ignoreEmpty- if false, honour destination file creation.
- Since:
- Ant 1.8.0
 
 - 
setResourceNamepublic void setResourceName(java.lang.String resourceName) Set the name that will be reported by the exposedResource.- Parameters:
- resourceName- to set
- Since:
- Ant 1.8.3
 
 - 
createPathpublic Path createPath() Path of files to concatenate.- Returns:
- the path used for concatenating
- Since:
- Ant 1.6
 
 - 
addFilesetpublic void addFileset(FileSet set) Set of files to concatenate.- Parameters:
- set- the set of files
 
 - 
addFilelistpublic void addFilelist(FileList list) List of files to concatenate.- Parameters:
- list- the list of files
 
 - 
addpublic void add(ResourceCollection c) Add an arbitrary ResourceCollection.- Parameters:
- c- the ResourceCollection to add.
- Since:
- Ant 1.7
 
 - 
addFilterChainpublic void addFilterChain(FilterChain filterChain) Adds a FilterChain.- Parameters:
- filterChain- a filterchain to filter the concatenated input
- Since:
- Ant 1.6
 
 - 
addTextpublic void addText(java.lang.String text) This method adds text which appears in the 'concat' element.- Parameters:
- text- the text to be concatenated.
 
 - 
addHeaderpublic void addHeader(Concat.TextElement headerToAdd) Add a header to the concatenated output- Parameters:
- headerToAdd- the header
- Since:
- Ant 1.6
 
 - 
addFooterpublic void addFooter(Concat.TextElement footerToAdd) Add a footer to the concatenated output- Parameters:
- footerToAdd- the footer
- Since:
- Ant 1.6
 
 - 
setFixLastLinepublic void setFixLastLine(boolean fixLastLine) Append line.separator to files that do not end with a line.separator, default false.- Parameters:
- fixLastLine- if true make sure each input file has new line on the concatenated stream
- Since:
- Ant 1.6
 
 - 
setEolpublic void setEol(FixCRLF.CrLf crlf) Specify the end of line to find and to add if not present at end of each input file. This attribute is used in conjunction with fixlastline.- Parameters:
- crlf- the type of new line to add - cr, mac, lf, unix, crlf, or dos
- Since:
- Ant 1.6
 
 - 
setWriterpublic void setWriter(java.io.Writer outputWriter) Set the output writer. This is to allow concat to be used as a nested element.- Parameters:
- outputWriter- the output writer.
- Since:
- Ant 1.6
 
 - 
setBinarypublic 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
 
 - 
iteratorpublic java.util.Iterator<Resource> iterator() Implement ResourceCollection.- Specified by:
- iteratorin interface- java.lang.Iterable<Resource>
- Returns:
- Iterator<Resource>.
 
 - 
sizepublic int size() Implement ResourceCollection.- Specified by:
- sizein interface- ResourceCollection
- Returns:
- 1.
 
 - 
isFilesystemOnlypublic boolean isFilesystemOnly() Implement ResourceCollection.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Returns:
- false.
 
 
- 
 
-