source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/filters/TokenFilter.ReplaceString.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: 15.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>
7TokenFilter.ReplaceString (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.filters.TokenFilter.ReplaceString 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="TokenFilter.ReplaceString (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/TokenFilter.ReplaceRegex.html" title="class in org.apache.tools.ant.filters"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.StringTokenizer.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="TokenFilter.ReplaceString.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;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">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 TokenFilter.ReplaceString</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/filters/TokenFilter.ChainableReaderFilter.html" title="class in org.apache.tools.ant.filters">org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.filters.TokenFilter.ReplaceString</B>
92</PRE>
93<DL>
94<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/filters/TokenFilter.Filter.html" title="interface in org.apache.tools.ant.filters">TokenFilter.Filter</A></DD>
95</DL>
96<DL>
97<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.html" title="class in org.apache.tools.ant.filters">TokenFilter</A></DD>
98</DL>
99<HR>
100<DL>
101<DT>public static class <B>TokenFilter.ReplaceString</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html" title="class in org.apache.tools.ant.filters">TokenFilter.ChainableReaderFilter</A></DL>
102
103<P>
104Simple replace string filter.
105<P>
106
107<P>
108<HR>
109
110<P>
111<!-- ======== NESTED CLASS SUMMARY ======== -->
112
113
114<!-- =========== FIELD SUMMARY =========== -->
115
116<A NAME="field_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TD COLSPAN=2><FONT SIZE="+2">
120<B>Field Summary</B></FONT></TD>
121</TR>
122</TABLE>
123&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
126<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>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
130</TR>
131</TABLE>
132&nbsp;
133<!-- ======== CONSTRUCTOR SUMMARY ======== -->
134
135<A NAME="constructor_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TD COLSPAN=2><FONT SIZE="+2">
139<B>Constructor Summary</B></FONT></TD>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ReplaceString.html#TokenFilter.ReplaceString()">TokenFilter.ReplaceString</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ========== METHOD SUMMARY =========== -->
150
151<A NAME="method_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TD COLSPAN=2><FONT SIZE="+2">
155<B>Method Summary</B></FONT></TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ReplaceString.html#filter(java.lang.String)">filter</A></B>(java.lang.String&nbsp;line)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Filter a string 'line' replacing from with to
164 (C&P from the Replace task)</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ReplaceString.html#setFrom(java.lang.String)">setFrom</A></B>(java.lang.String&nbsp;from)</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the from attribute</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>&nbsp;void</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ReplaceString.html#setTo(java.lang.String)">setTo</A></B>(java.lang.String&nbsp;to)</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the to attribute</TD>
181</TR>
182</TABLE>
183&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
186<TD><B>Methods inherited from class org.apache.tools.ant.filters.<A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html" title="class in org.apache.tools.ant.filters">TokenFilter.ChainableReaderFilter</A></B></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE><A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html#chain(java.io.Reader)">chain</A>, <A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html#setByLine(boolean)">setByLine</A></CODE></TD>
190</TR>
191</TABLE>
192&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
193<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
195<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>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
199</TR>
200</TABLE>
201&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
204<TD><B>Methods inherited from class java.lang.Object</B></TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
208</TR>
209</TABLE>
210&nbsp;
211<P>
212
213<!-- ============ FIELD DETAIL =========== -->
214
215
216<!-- ========= CONSTRUCTOR DETAIL ======== -->
217
218<A NAME="constructor_detail"><!-- --></A>
219<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221<TD COLSPAN=1><FONT SIZE="+2">
222<B>Constructor Detail</B></FONT></TD>
223</TR>
224</TABLE>
225
226<A NAME="TokenFilter.ReplaceString()"><!-- --></A><H3>
227TokenFilter.ReplaceString</H3>
228<PRE>
229public <B>TokenFilter.ReplaceString</B>()</PRE>
230<DL>
231</DL>
232
233<!-- ============ METHOD DETAIL ========== -->
234
235<A NAME="method_detail"><!-- --></A>
236<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
237<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
238<TD COLSPAN=1><FONT SIZE="+2">
239<B>Method Detail</B></FONT></TD>
240</TR>
241</TABLE>
242
243<A NAME="setFrom(java.lang.String)"><!-- --></A><H3>
244setFrom</H3>
245<PRE>
246public void <B>setFrom</B>(java.lang.String&nbsp;from)</PRE>
247<DL>
248<DD>the from attribute
249<P>
250<DD><DL>
251<DT><B>Parameters:</B><DD><CODE>from</CODE> - the string to replace</DL>
252</DD>
253</DL>
254<HR>
255
256<A NAME="setTo(java.lang.String)"><!-- --></A><H3>
257setTo</H3>
258<PRE>
259public void <B>setTo</B>(java.lang.String&nbsp;to)</PRE>
260<DL>
261<DD>the to attribute
262<P>
263<DD><DL>
264<DT><B>Parameters:</B><DD><CODE>to</CODE> - the string to replace 'from' with</DL>
265</DD>
266</DL>
267<HR>
268
269<A NAME="filter(java.lang.String)"><!-- --></A><H3>
270filter</H3>
271<PRE>
272public java.lang.String <B>filter</B>(java.lang.String&nbsp;line)</PRE>
273<DL>
274<DD>Filter a string 'line' replacing from with to
275 (C&P from the Replace task)
276<P>
277<DD><DL>
278<DT><B>Parameters:</B><DD><CODE>line</CODE> - the string to be filtered
279<DT><B>Returns:</B><DD>the filtered line</DL>
280</DD>
281</DL>
282<!-- ========= END OF CLASS DATA ========= -->
283<HR>
284
285
286<!-- ======= START OF BOTTOM NAVBAR ====== -->
287<A NAME="navbar_bottom"><!-- --></A>
288<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
289<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
290<TR>
291<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
292<A NAME="navbar_bottom_firstrow"><!-- --></A>
293<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
294 <TR ALIGN="center" VALIGN="top">
295 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
296 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
297 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
302 </TR>
303</TABLE>
304</TD>
305<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
306</EM>
307</TD>
308</TR>
309
310<TR>
311<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
312&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.ReplaceRegex.html" title="class in org.apache.tools.ant.filters"><B>PREV CLASS</B></A>&nbsp;
313&nbsp;<A HREF="../../../../../org/apache/tools/ant/filters/TokenFilter.StringTokenizer.html" title="class in org.apache.tools.ant.filters"><B>NEXT CLASS</B></A></FONT></TD>
314<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
315 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
316&nbsp;<A HREF="TokenFilter.ReplaceString.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
317&nbsp;<SCRIPT type="text/javascript">
318 <!--
319 if(window==top) {
320 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
321 }
322 //-->
323</SCRIPT>
324<NOSCRIPT>
325 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
326</NOSCRIPT>
327
328</FONT></TD>
329</TR>
330<TR>
331<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
332 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
333<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
334DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
335</TR>
336</TABLE>
337<A NAME="skip-navbar_bottom"></A>
338<!-- ======== END OF BOTTOM NAVBAR ======= -->
339
340<HR>
341Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
342</BODY>
343</HTML>
Note: See TracBrowser for help on using the repository browser.