source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 21.2 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:16 NZST 2007 -->
6<TITLE>
7ReplaceTokens (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.filters.ReplaceTokens 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="ReplaceTokens (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/filters/PrefixLines.html" title="class in org.apache.tools.ant.filters"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.Token.html" title="class in org.apache.tools.ant.filters"><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="ReplaceTokens.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_java.io.FilterReader">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.filters</FONT>
85<BR>
86Class ReplaceTokens</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">java.io.Reader
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">java.io.FilterReader
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html" title="class in org.apache.tools.ant.filters">org.apache.tools.ant.filters.BaseFilterReader</A>
92 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html" title="class in org.apache.tools.ant.filters">org.apache.tools.ant.filters.BaseParamFilterReader</A>
93 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.filters.ReplaceTokens</B>
94</PRE>
95<DL>
96<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/filters/ChainableReader.html" title="interface in org.apache.tools.ant.filters">ChainableReader</A>, <A HREF="../../../../../org/apache/tools/ant/types/Parameterizable.html" title="interface in org.apache.tools.ant.types">Parameterizable</A></DD>
97</DL>
98<HR>
99<DL>
100<DT>public final class <B>ReplaceTokens</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html" title="class in org.apache.tools.ant.filters">BaseParamFilterReader</A><DT>implements <A HREF="../../../../../org/apache/tools/ant/filters/ChainableReader.html" title="interface in org.apache.tools.ant.filters">ChainableReader</A></DL>
101
102<P>
103Replaces tokens in the original input with user-supplied values.
104
105 Example:
106
107 <pre>&lt;replacetokens begintoken=&quot;#&quot; endtoken=&quot;#&quot;&gt;
108 &lt;token key=&quot;DATE&quot; value=&quot;${TODAY}&quot;/&gt;
109 &lt;/replacetokens&gt;</pre>
110
111 Or:
112
113 <pre>&lt;filterreader classname="org.apache.tools.ant.filters.ReplaceTokens"&gt;
114 &lt;param type="tokenchar" name="begintoken" value="#"/&gt;
115 &lt;param type="tokenchar" name="endtoken" value="#"/&gt;
116 &lt;param type="token" name="DATE" value="${TODAY}"/&gt;
117 &lt;/filterreader&gt;</pre>
118<P>
119
120<P>
121<HR>
122
123<P>
124<!-- ======== NESTED CLASS SUMMARY ======== -->
125
126<A NAME="nested_class_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TD COLSPAN=2><FONT SIZE="+2">
130<B>Nested Class Summary</B></FONT></TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>static&nbsp;class</CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.Token.html" title="class in org.apache.tools.ant.filters">ReplaceTokens.Token</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Holds a token</TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- =========== FIELD SUMMARY =========== -->
143
144<A NAME="field_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TD COLSPAN=2><FONT SIZE="+2">
148<B>Field Summary</B></FONT></TD>
149</TR>
150</TABLE>
151&nbsp;<A NAME="fields_inherited_from_class_java.io.FilterReader"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
154<TD><B>Fields inherited from class java.io.FilterReader</B></TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD><CODE>in</CODE></TD>
158</TR>
159</TABLE>
160&nbsp;<A NAME="fields_inherited_from_class_java.io.Reader"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
163<TD><B>Fields inherited from class java.io.Reader</B></TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD><CODE>lock</CODE></TD>
167</TR>
168</TABLE>
169&nbsp;
170<!-- ======== CONSTRUCTOR SUMMARY ======== -->
171
172<A NAME="constructor_summary"><!-- --></A>
173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
175<TD COLSPAN=2><FONT SIZE="+2">
176<B>Constructor Summary</B></FONT></TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#ReplaceTokens()">ReplaceTokens</A></B>()</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for "dummy" instances.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#ReplaceTokens(java.io.Reader)">ReplaceTokens</A></B>(java.io.Reader&nbsp;in)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new filtered reader.</TD>
189</TR>
190</TABLE>
191&nbsp;
192<!-- ========== METHOD SUMMARY =========== -->
193
194<A NAME="method_summary"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
197<TD COLSPAN=2><FONT SIZE="+2">
198<B>Method Summary</B></FONT></TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;void</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#addConfiguredToken(org.apache.tools.ant.filters.ReplaceTokens.Token)">addConfiguredToken</A></B>(<A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.Token.html" title="class in org.apache.tools.ant.filters">ReplaceTokens.Token</A>&nbsp;token)</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a token element to the map of tokens to replace.</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&nbsp;java.io.Reader</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#chain(java.io.Reader)">chain</A></B>(java.io.Reader&nbsp;rdr)</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ReplaceTokens using the passed in
215 Reader for instantiation.</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219<CODE>&nbsp;int</CODE></FONT></TD>
220<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#read()">read</A></B>()</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next character in the filtered stream, replacing tokens
224 from the original stream.</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;void</CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#setBeginToken(char)">setBeginToken</A></B>(char&nbsp;beginToken)</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the "begin token" character.</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>&nbsp;void</CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.html#setEndToken(char)">setEndToken</A></B>(char&nbsp;endToken)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the "end token" character.</TD>
241</TR>
242</TABLE>
243&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.filters.BaseParamFilterReader"><!-- --></A>
244<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
245<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
246<TD><B>Methods inherited from class org.apache.tools.ant.filters.<A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html" title="class in org.apache.tools.ant.filters">BaseParamFilterReader</A></B></TD>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<TD><CODE><A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html#getParameters()">getParameters</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseParamFilterReader.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></CODE></TD>
250</TR>
251</TABLE>
252&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.filters.BaseFilterReader"><!-- --></A>
253<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
254<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
255<TD><B>Methods inherited from class org.apache.tools.ant.filters.<A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html" title="class in org.apache.tools.ant.filters">BaseFilterReader</A></B></TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD><CODE><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#getInitialized()">getInitialized</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#read(char[], int, int)">read</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#readFully()">readFully</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#readLine()">readLine</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#setInitialized(boolean)">setInitialized</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#setProject(org.apache.tools.ant.Project)">setProject</A>, <A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#skip(long)">skip</A></CODE></TD>
259</TR>
260</TABLE>
261&nbsp;<A NAME="methods_inherited_from_class_java.io.FilterReader"><!-- --></A>
262<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
264<TD><B>Methods inherited from class java.io.FilterReader</B></TD>
265</TR>
266<TR BGCOLOR="white" CLASS="TableRowColor">
267<TD><CODE>close, mark, markSupported, ready, reset</CODE></TD>
268</TR>
269</TABLE>
270&nbsp;<A NAME="methods_inherited_from_class_java.io.Reader"><!-- --></A>
271<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
272<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
273<TD><B>Methods inherited from class java.io.Reader</B></TD>
274</TR>
275<TR BGCOLOR="white" CLASS="TableRowColor">
276<TD><CODE>read</CODE></TD>
277</TR>
278</TABLE>
279&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
280<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
281<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
282<TD><B>Methods inherited from class java.lang.Object</B></TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
286</TR>
287</TABLE>
288&nbsp;
289<P>
290
291<!-- ============ FIELD DETAIL =========== -->
292
293
294<!-- ========= CONSTRUCTOR DETAIL ======== -->
295
296<A NAME="constructor_detail"><!-- --></A>
297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
299<TD COLSPAN=1><FONT SIZE="+2">
300<B>Constructor Detail</B></FONT></TD>
301</TR>
302</TABLE>
303
304<A NAME="ReplaceTokens()"><!-- --></A><H3>
305ReplaceTokens</H3>
306<PRE>
307public <B>ReplaceTokens</B>()</PRE>
308<DL>
309<DD>Constructor for "dummy" instances.
310<P>
311<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/filters/BaseFilterReader.html#BaseFilterReader()"><CODE>BaseFilterReader.BaseFilterReader()</CODE></A></DL>
312<HR>
313
314<A NAME="ReplaceTokens(java.io.Reader)"><!-- --></A><H3>
315ReplaceTokens</H3>
316<PRE>
317public <B>ReplaceTokens</B>(java.io.Reader&nbsp;in)</PRE>
318<DL>
319<DD>Creates a new filtered reader.
320<P>
321<DT><B>Parameters:</B><DD><CODE>in</CODE> - A Reader object providing the underlying stream.
322 Must not be <code>null</code>.</DL>
323
324<!-- ============ METHOD DETAIL ========== -->
325
326<A NAME="method_detail"><!-- --></A>
327<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
328<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
329<TD COLSPAN=1><FONT SIZE="+2">
330<B>Method Detail</B></FONT></TD>
331</TR>
332</TABLE>
333
334<A NAME="read()"><!-- --></A><H3>
335read</H3>
336<PRE>
337public final int <B>read</B>()
338 throws java.io.IOException</PRE>
339<DL>
340<DD>Returns the next character in the filtered stream, replacing tokens
341 from the original stream.
342<P>
343<DD><DL>
344</DL>
345</DD>
346<DD><DL>
347
348<DT><B>Returns:</B><DD>the next character in the resulting stream, or -1
349 if the end of the resulting stream has been reached
350<DT><B>Throws:</B>
351<DD><CODE>java.io.IOException</CODE> - if the underlying stream throws an IOException
352 during reading</DL>
353</DD>
354</DL>
355<HR>
356
357<A NAME="setBeginToken(char)"><!-- --></A><H3>
358setBeginToken</H3>
359<PRE>
360public final void <B>setBeginToken</B>(char&nbsp;beginToken)</PRE>
361<DL>
362<DD>Sets the "begin token" character.
363<P>
364<DD><DL>
365</DL>
366</DD>
367<DD><DL>
368<DT><B>Parameters:</B><DD><CODE>beginToken</CODE> - the character used to denote the beginning of a token</DL>
369</DD>
370</DL>
371<HR>
372
373<A NAME="setEndToken(char)"><!-- --></A><H3>
374setEndToken</H3>
375<PRE>
376public final void <B>setEndToken</B>(char&nbsp;endToken)</PRE>
377<DL>
378<DD>Sets the "end token" character.
379<P>
380<DD><DL>
381</DL>
382</DD>
383<DD><DL>
384<DT><B>Parameters:</B><DD><CODE>endToken</CODE> - the character used to denote the end of a token</DL>
385</DD>
386</DL>
387<HR>
388
389<A NAME="addConfiguredToken(org.apache.tools.ant.filters.ReplaceTokens.Token)"><!-- --></A><H3>
390addConfiguredToken</H3>
391<PRE>
392public final void <B>addConfiguredToken</B>(<A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.Token.html" title="class in org.apache.tools.ant.filters">ReplaceTokens.Token</A>&nbsp;token)</PRE>
393<DL>
394<DD>Adds a token element to the map of tokens to replace.
395<P>
396<DD><DL>
397</DL>
398</DD>
399<DD><DL>
400<DT><B>Parameters:</B><DD><CODE>token</CODE> - The token to add to the map of replacements.
401 Must not be <code>null</code>.</DL>
402</DD>
403</DL>
404<HR>
405
406<A NAME="chain(java.io.Reader)"><!-- --></A><H3>
407chain</H3>
408<PRE>
409public final java.io.Reader <B>chain</B>(java.io.Reader&nbsp;rdr)</PRE>
410<DL>
411<DD>Creates a new ReplaceTokens using the passed in
412 Reader for instantiation.
413<P>
414<DD><DL>
415<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/filters/ChainableReader.html#chain(java.io.Reader)">chain</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/filters/ChainableReader.html" title="interface in org.apache.tools.ant.filters">ChainableReader</A></CODE></DL>
416</DD>
417<DD><DL>
418<DT><B>Parameters:</B><DD><CODE>rdr</CODE> - A Reader object providing the underlying stream.
419 Must not be <code>null</code>.
420<DT><B>Returns:</B><DD>a new filter based on this configuration, but filtering
421 the specified reader</DL>
422</DD>
423</DL>
424<!-- ========= END OF CLASS DATA ========= -->
425<HR>
426
427
428<!-- ======= START OF BOTTOM NAVBAR ====== -->
429<A NAME="navbar_bottom"><!-- --></A>
430<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
431<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
432<TR>
433<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
434<A NAME="navbar_bottom_firstrow"><!-- --></A>
435<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
436 <TR ALIGN="center" VALIGN="top">
437 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
438 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
439 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
440 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
441 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
442 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
443 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
444 </TR>
445</TABLE>
446</TD>
447<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
448</EM>
449</TD>
450</TR>
451
452<TR>
453<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
454&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/PrefixLines.html" title="class in org.apache.tools.ant.filters"><B>PREV CLASS</B></A>&nbsp;
455&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/ReplaceTokens.Token.html" title="class in org.apache.tools.ant.filters"><B>NEXT CLASS</B></A></FONT></TD>
456<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
457 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
458&nbsp;<A HREF="ReplaceTokens.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
459&nbsp;<SCRIPT type="text/javascript">
460 <!--
461 if(window==top) {
462 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
463 }
464 //-->
465</SCRIPT>
466<NOSCRIPT>
467 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
468</NOSCRIPT>
469
470</FONT></TD>
471</TR>
472<TR>
473<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
474 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_java.io.FilterReader">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
475<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
476DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
477</TR>
478</TABLE>
479<A NAME="skip-navbar_bottom"></A>
480<!-- ======== END OF BOTTOM NAVBAR ======= -->
481
482<HR>
483Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
484</BODY>
485</HTML>
Note: See TracBrowser for help on using the repository browser.