source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/Concat.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker

File size: 31.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:18 NZST 2007 -->
6<TITLE>
7Concat (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Concat class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Concat (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Chmod.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Concat.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs</FONT>
85<BR>
86Class Concat</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Concat</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>Concat</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98This class contains the 'concat' task, used to concatenate a series
99 of files into a single stream. The destination of this stream may
100 be the system console, or a file. The following is a sample
101 invocation:
102
103 <pre>
104 &lt;concat destfile=&quot;${build.dir}/index.xml&quot;
105 append=&quot;false&quot;&gt;
106
107 &lt;fileset dir=&quot;${xml.root.dir}&quot;
108 includes=&quot;*.xml&quot; /&gt;
109
110 &lt;/concat&gt;
111 </pre>
112<P>
113
114<P>
115<HR>
116
117<P>
118<!-- ======== NESTED CLASS SUMMARY ======== -->
119
120<A NAME="nested_class_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TD COLSPAN=2><FONT SIZE="+2">
124<B>Nested Class Summary</B></FONT></TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>static&nbsp;class</CODE></FONT></TD>
129<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs">Concat.TextElement</A></B></CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sub element points to a file or contains text</TD>
133</TR>
134</TABLE>
135&nbsp;
136<!-- =========== FIELD SUMMARY =========== -->
137
138<A NAME="field_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TD COLSPAN=2><FONT SIZE="+2">
142<B>Field Summary</B></FONT></TD>
143</TR>
144</TABLE>
145&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
148<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
152</TR>
153</TABLE>
154&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
157<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ======== CONSTRUCTOR SUMMARY ======== -->
165
166<A NAME="constructor_summary"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TD COLSPAN=2><FONT SIZE="+2">
170<B>Constructor Summary</B></FONT></TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#Concat()">Concat</A></B>()</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ========== METHOD SUMMARY =========== -->
181
182<A NAME="method_summary"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TD COLSPAN=2><FONT SIZE="+2">
186<B>Method Summary</B></FONT></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;void</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#addFilelist(org.apache.tools.ant.types.FileList)">addFilelist</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</A>&nbsp;list)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List of files to concatenate.</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;void</CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set of files to concatenate.</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;void</CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#addFilterChain(org.apache.tools.ant.types.FilterChain)">addFilterChain</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</A>&nbsp;filterChain)</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a FilterChain.</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;void</CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#addFooter(org.apache.tools.ant.taskdefs.Concat.TextElement)">addFooter</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs">Concat.TextElement</A>&nbsp;footer)</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a footer to the concatenated output</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>&nbsp;void</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#addHeader(org.apache.tools.ant.taskdefs.Concat.TextElement)">addHeader</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs">Concat.TextElement</A>&nbsp;header)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a header to the concatenated output</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>&nbsp;void</CODE></FONT></TD>
231<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#addText(java.lang.String)">addText</A></B>(java.lang.String&nbsp;text)</CODE>
232
233<BR>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method adds text which appears in the 'concat' element.</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#createPath()">createPath</A></B>()</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Path of files to concatenate.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;void</CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#execute()">execute</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;execute the concat task.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;void</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#reset()">reset</A></B>()</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset state to default.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>&nbsp;void</CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setAppend(boolean)">setAppend</A></B>(boolean&nbsp;append)</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the behavior when the destination file exists.</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>&nbsp;void</CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setBinary(boolean)">setBinary</A></B>(boolean&nbsp;binary)</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the binary attribute.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;void</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setDestfile(java.io.File)">setDestfile</A></B>(java.io.File&nbsp;destinationFile)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the destination file, or uses the console if not specified.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;void</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String&nbsp;encoding)</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the character encoding</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;void</CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setEol(org.apache.tools.ant.taskdefs.FixCRLF.CrLf)">setEol</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/FixCRLF.CrLf.html" title="class in org.apache.tools.ant.taskdefs">FixCRLF.CrLf</A>&nbsp;crlf)</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specify the end of line to find and to add if
299 not present at end of each input file.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>&nbsp;void</CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setFixLastLine(boolean)">setFixLastLine</A></B>(boolean&nbsp;fixLastLine)</CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Append line.separator to files that do not end
308 with a line.separator, default false.</TD>
309</TR>
310<TR BGCOLOR="white" CLASS="TableRowColor">
311<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312<CODE>&nbsp;void</CODE></FONT></TD>
313<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setForce(boolean)">setForce</A></B>(boolean&nbsp;force)</CODE>
314
315<BR>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Force overwrite existing destination file</TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320<CODE>&nbsp;void</CODE></FONT></TD>
321<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setOutputEncoding(java.lang.String)">setOutputEncoding</A></B>(java.lang.String&nbsp;outputEncoding)</CODE>
322
323<BR>
324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the character encoding for outputting</TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328<CODE>&nbsp;void</CODE></FONT></TD>
329<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.html#setWriter(java.io.Writer)">setWriter</A></B>(java.io.Writer&nbsp;outputWriter)</CODE>
330
331<BR>
332&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the output writer, this is to allow
333 concat to be used as a nested element</TD>
334</TR>
335</TABLE>
336&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
337<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
338<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
339<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
340</TR>
341<TR BGCOLOR="white" CLASS="TableRowColor">
342<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
343</TR>
344</TABLE>
345&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
346<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
347<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
348<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
352</TR>
353</TABLE>
354&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
356<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
357<TD><B>Methods inherited from class java.lang.Object</B></TD>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
361</TR>
362</TABLE>
363&nbsp;
364<P>
365
366<!-- ============ FIELD DETAIL =========== -->
367
368
369<!-- ========= CONSTRUCTOR DETAIL ======== -->
370
371<A NAME="constructor_detail"><!-- --></A>
372<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
373<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
374<TD COLSPAN=1><FONT SIZE="+2">
375<B>Constructor Detail</B></FONT></TD>
376</TR>
377</TABLE>
378
379<A NAME="Concat()"><!-- --></A><H3>
380Concat</H3>
381<PRE>
382public <B>Concat</B>()</PRE>
383<DL>
384</DL>
385
386<!-- ============ METHOD DETAIL ========== -->
387
388<A NAME="method_detail"><!-- --></A>
389<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
390<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
391<TD COLSPAN=1><FONT SIZE="+2">
392<B>Method Detail</B></FONT></TD>
393</TR>
394</TABLE>
395
396<A NAME="setDestfile(java.io.File)"><!-- --></A><H3>
397setDestfile</H3>
398<PRE>
399public void <B>setDestfile</B>(java.io.File&nbsp;destinationFile)</PRE>
400<DL>
401<DD>Sets the destination file, or uses the console if not specified.
402<P>
403<DD><DL>
404<DT><B>Parameters:</B><DD><CODE>destinationFile</CODE> - the destination file</DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="setAppend(boolean)"><!-- --></A><H3>
410setAppend</H3>
411<PRE>
412public void <B>setAppend</B>(boolean&nbsp;append)</PRE>
413<DL>
414<DD>Sets the behavior when the destination file exists. If set to
415 <code>true</code> the stream data will be appended to the
416 existing file, otherwise the existing file will be
417 overwritten. Defaults to <code>false</code>.
418<P>
419<DD><DL>
420<DT><B>Parameters:</B><DD><CODE>append</CODE> - if true append to the file.</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
426setEncoding</H3>
427<PRE>
428public void <B>setEncoding</B>(java.lang.String&nbsp;encoding)</PRE>
429<DL>
430<DD>Sets the character encoding
431<P>
432<DD><DL>
433<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the encoding of the input stream and unless
434 outputencoding is set, the outputstream.</DL>
435</DD>
436</DL>
437<HR>
438
439<A NAME="setOutputEncoding(java.lang.String)"><!-- --></A><H3>
440setOutputEncoding</H3>
441<PRE>
442public void <B>setOutputEncoding</B>(java.lang.String&nbsp;outputEncoding)</PRE>
443<DL>
444<DD>Sets the character encoding for outputting
445<P>
446<DD><DL>
447<DT><B>Parameters:</B><DD><CODE>outputEncoding</CODE> - the encoding for the output file<DT><B>Since:</B></DT>
448 <DD>Ant 1.6</DD>
449</DL>
450</DD>
451</DL>
452<HR>
453
454<A NAME="setForce(boolean)"><!-- --></A><H3>
455setForce</H3>
456<PRE>
457public void <B>setForce</B>(boolean&nbsp;force)</PRE>
458<DL>
459<DD>Force overwrite existing destination file
460<P>
461<DD><DL>
462<DT><B>Parameters:</B><DD><CODE>force</CODE> - if true always overwrite, otherwise only overwrite
463 if the output file is older any of the input files.<DT><B>Since:</B></DT>
464 <DD>Ant 1.6</DD>
465</DL>
466</DD>
467</DL>
468<HR>
469
470<A NAME="createPath()"><!-- --></A><H3>
471createPath</H3>
472<PRE>
473public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createPath</B>()</PRE>
474<DL>
475<DD>Path of files to concatenate.
476<P>
477<DD><DL>
478
479<DT><B>Returns:</B><DD>the path used for concatenating<DT><B>Since:</B></DT>
480 <DD>Ant 1.6</DD>
481</DL>
482</DD>
483</DL>
484<HR>
485
486<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
487addFileset</H3>
488<PRE>
489public void <B>addFileset</B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</PRE>
490<DL>
491<DD>Set of files to concatenate.
492<P>
493<DD><DL>
494<DT><B>Parameters:</B><DD><CODE>set</CODE> - the set of files</DL>
495</DD>
496</DL>
497<HR>
498
499<A NAME="addFilelist(org.apache.tools.ant.types.FileList)"><!-- --></A><H3>
500addFilelist</H3>
501<PRE>
502public void <B>addFilelist</B>(<A HREF="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types">FileList</A>&nbsp;list)</PRE>
503<DL>
504<DD>List of files to concatenate.
505<P>
506<DD><DL>
507<DT><B>Parameters:</B><DD><CODE>list</CODE> - the list of files</DL>
508</DD>
509</DL>
510<HR>
511
512<A NAME="addFilterChain(org.apache.tools.ant.types.FilterChain)"><!-- --></A><H3>
513addFilterChain</H3>
514<PRE>
515public void <B>addFilterChain</B>(<A HREF="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</A>&nbsp;filterChain)</PRE>
516<DL>
517<DD>Adds a FilterChain.
518<P>
519<DD><DL>
520<DT><B>Parameters:</B><DD><CODE>filterChain</CODE> - a filterchain to filter the concatenated input<DT><B>Since:</B></DT>
521 <DD>Ant 1.6</DD>
522</DL>
523</DD>
524</DL>
525<HR>
526
527<A NAME="addText(java.lang.String)"><!-- --></A><H3>
528addText</H3>
529<PRE>
530public void <B>addText</B>(java.lang.String&nbsp;text)</PRE>
531<DL>
532<DD>This method adds text which appears in the 'concat' element.
533<P>
534<DD><DL>
535<DT><B>Parameters:</B><DD><CODE>text</CODE> - the text to be concated.</DL>
536</DD>
537</DL>
538<HR>
539
540<A NAME="addHeader(org.apache.tools.ant.taskdefs.Concat.TextElement)"><!-- --></A><H3>
541addHeader</H3>
542<PRE>
543public void <B>addHeader</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs">Concat.TextElement</A>&nbsp;header)</PRE>
544<DL>
545<DD>Add a header to the concatenated output
546<P>
547<DD><DL>
548<DT><B>Parameters:</B><DD><CODE>header</CODE> - the header<DT><B>Since:</B></DT>
549 <DD>Ant 1.6</DD>
550</DL>
551</DD>
552</DL>
553<HR>
554
555<A NAME="addFooter(org.apache.tools.ant.taskdefs.Concat.TextElement)"><!-- --></A><H3>
556addFooter</H3>
557<PRE>
558public void <B>addFooter</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs">Concat.TextElement</A>&nbsp;footer)</PRE>
559<DL>
560<DD>Add a footer to the concatenated output
561<P>
562<DD><DL>
563<DT><B>Parameters:</B><DD><CODE>footer</CODE> - the footer<DT><B>Since:</B></DT>
564 <DD>Ant 1.6</DD>
565</DL>
566</DD>
567</DL>
568<HR>
569
570<A NAME="setFixLastLine(boolean)"><!-- --></A><H3>
571setFixLastLine</H3>
572<PRE>
573public void <B>setFixLastLine</B>(boolean&nbsp;fixLastLine)</PRE>
574<DL>
575<DD>Append line.separator to files that do not end
576 with a line.separator, default false.
577<P>
578<DD><DL>
579<DT><B>Parameters:</B><DD><CODE>fixLastLine</CODE> - if true make sure each input file has
580 new line on the concatenated stream<DT><B>Since:</B></DT>
581 <DD>Ant 1.6</DD>
582</DL>
583</DD>
584</DL>
585<HR>
586
587<A NAME="setEol(org.apache.tools.ant.taskdefs.FixCRLF.CrLf)"><!-- --></A><H3>
588setEol</H3>
589<PRE>
590public void <B>setEol</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/FixCRLF.CrLf.html" title="class in org.apache.tools.ant.taskdefs">FixCRLF.CrLf</A>&nbsp;crlf)</PRE>
591<DL>
592<DD>Specify the end of line to find and to add if
593 not present at end of each input file. This attribute
594 is used in conjunction with fixlastline.
595<P>
596<DD><DL>
597<DT><B>Parameters:</B><DD><CODE>crlf</CODE> - the type of new line to add -
598 cr, mac, lf, unix, crlf, or dos<DT><B>Since:</B></DT>
599 <DD>Ant 1.6</DD>
600</DL>
601</DD>
602</DL>
603<HR>
604
605<A NAME="setWriter(java.io.Writer)"><!-- --></A><H3>
606setWriter</H3>
607<PRE>
608public void <B>setWriter</B>(java.io.Writer&nbsp;outputWriter)</PRE>
609<DL>
610<DD>set the output writer, this is to allow
611 concat to be used as a nested element
612<P>
613<DD><DL>
614<DT><B>Parameters:</B><DD><CODE>outputWriter</CODE> - the output writer<DT><B>Since:</B></DT>
615 <DD>Ant 1.6</DD>
616</DL>
617</DD>
618</DL>
619<HR>
620
621<A NAME="setBinary(boolean)"><!-- --></A><H3>
622setBinary</H3>
623<PRE>
624public void <B>setBinary</B>(boolean&nbsp;binary)</PRE>
625<DL>
626<DD>set the binary attribute.
627 if true, concat will concatenate the files
628 byte for byte. This mode does not allow
629 any filtering, or other modifications
630 to the input streams.
631 The default value is false.
632<P>
633<DD><DL>
634<DT><B>Parameters:</B><DD><CODE>binary</CODE> - if true, enable binary mode<DT><B>Since:</B></DT>
635 <DD>ant 1.6.2</DD>
636</DL>
637</DD>
638</DL>
639<HR>
640
641<A NAME="execute()"><!-- --></A><H3>
642execute</H3>
643<PRE>
644public void <B>execute</B>()</PRE>
645<DL>
646<DD>execute the concat task.
647<P>
648<DD><DL>
649<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
650</DD>
651<DD><DL>
652</DL>
653</DD>
654</DL>
655<HR>
656
657<A NAME="reset()"><!-- --></A><H3>
658reset</H3>
659<PRE>
660public void <B>reset</B>()</PRE>
661<DL>
662<DD>Reset state to default.
663<P>
664<DD><DL>
665</DL>
666</DD>
667</DL>
668<!-- ========= END OF CLASS DATA ========= -->
669<HR>
670
671
672<!-- ======= START OF BOTTOM NAVBAR ====== -->
673<A NAME="navbar_bottom"><!-- --></A>
674<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
675<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
676<TR>
677<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
678<A NAME="navbar_bottom_firstrow"><!-- --></A>
679<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
680 <TR ALIGN="center" VALIGN="top">
681 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
682 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
683 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
684 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
685 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
686 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
687 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
688 </TR>
689</TABLE>
690</TD>
691<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
692</EM>
693</TD>
694</TR>
695
696<TR>
697<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
698&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Chmod.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
699&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Concat.TextElement.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
700<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
701 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
702&nbsp;<A HREF="Concat.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
703&nbsp;<SCRIPT type="text/javascript">
704 <!--
705 if(window==top) {
706 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
707 }
708 //-->
709</SCRIPT>
710<NOSCRIPT>
711 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
712</NOSCRIPT>
713
714</FONT></TD>
715</TR>
716<TR>
717<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
718 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
719<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
720DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
721</TR>
722</TABLE>
723<A NAME="skip-navbar_bottom"></A>
724<!-- ======== END OF BOTTOM NAVBAR ======= -->
725
726<HR>
727Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
728</BODY>
729</HTML>
Note: See TracBrowser for help on using the repository browser.