source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/Replace.Replacefilter.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: 14.9 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:21 NZST 2007 -->
6<TITLE>
7Replace.Replacefilter (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Replace.Replacefilter 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="Replace.Replacefilter (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/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Rmic.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="Replace.Replacefilter.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;FIELD&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 Replace.Replacefilter</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Replace.Replacefilter</B>
90</PRE>
91<DL>
92<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html" title="class in org.apache.tools.ant.taskdefs">Replace</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>Replace.Replacefilter</B><DT>extends java.lang.Object</DL>
97
98<P>
99A filter to apply.
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108
109<!-- =========== FIELD SUMMARY =========== -->
110
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TD COLSPAN=2><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TD>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#Replace.Replacefilter()">Replace.Replacefilter</A></B>()</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- ========== METHOD SUMMARY =========== -->
129
130<A NAME="method_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TD COLSPAN=2><FONT SIZE="+2">
134<B>Method Summary</B></FONT></TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#getProperty()">getProperty</A></B>()</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the property whose value is to serve as
143 the replacement value;</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#getReplaceValue()">getReplaceValue</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the replacement value for this filter token.</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#getToken()">getToken</A></B>()</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the string to search for</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#getValue()">getValue</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get replacements string</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#setProperty(java.lang.String)">setProperty</A></B>(java.lang.String&nbsp;property)</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the property whose value is to serve as
176 the replacement value; required if <code>value</code> is not set.</TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>&nbsp;void</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#setToken(java.lang.String)">setToken</A></B>(java.lang.String&nbsp;token)</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the token to replace</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>&nbsp;void</CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String&nbsp;value)</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The replacement string; required if <code>property<code>
193 is not set</TD>
194</TR>
195<TR BGCOLOR="white" CLASS="TableRowColor">
196<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197<CODE>&nbsp;void</CODE></FONT></TD>
198<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html#validate()">validate</A></B>()</CODE>
199
200<BR>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;validate the filter's configuration</TD>
202</TR>
203</TABLE>
204&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
205<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
206<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
207<TD><B>Methods inherited from class java.lang.Object</B></TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
211</TR>
212</TABLE>
213&nbsp;
214<P>
215
216<!-- ============ FIELD DETAIL =========== -->
217
218
219<!-- ========= CONSTRUCTOR DETAIL ======== -->
220
221<A NAME="constructor_detail"><!-- --></A>
222<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
223<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
224<TD COLSPAN=1><FONT SIZE="+2">
225<B>Constructor Detail</B></FONT></TD>
226</TR>
227</TABLE>
228
229<A NAME="Replace.Replacefilter()"><!-- --></A><H3>
230Replace.Replacefilter</H3>
231<PRE>
232public <B>Replace.Replacefilter</B>()</PRE>
233<DL>
234</DL>
235
236<!-- ============ METHOD DETAIL ========== -->
237
238<A NAME="method_detail"><!-- --></A>
239<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
240<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
241<TD COLSPAN=1><FONT SIZE="+2">
242<B>Method Detail</B></FONT></TD>
243</TR>
244</TABLE>
245
246<A NAME="validate()"><!-- --></A><H3>
247validate</H3>
248<PRE>
249public void <B>validate</B>()
250 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
251<DL>
252<DD>validate the filter's configuration
253<P>
254<DD><DL>
255
256<DT><B>Throws:</B>
257<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any part is invalid</DL>
258</DD>
259</DL>
260<HR>
261
262<A NAME="getReplaceValue()"><!-- --></A><H3>
263getReplaceValue</H3>
264<PRE>
265public java.lang.String <B>getReplaceValue</B>()</PRE>
266<DL>
267<DD>Get the replacement value for this filter token.
268<P>
269<DD><DL>
270
271<DT><B>Returns:</B><DD>the replacement value</DL>
272</DD>
273</DL>
274<HR>
275
276<A NAME="setToken(java.lang.String)"><!-- --></A><H3>
277setToken</H3>
278<PRE>
279public void <B>setToken</B>(java.lang.String&nbsp;token)</PRE>
280<DL>
281<DD>Set the token to replace
282<P>
283<DD><DL>
284<DT><B>Parameters:</B><DD><CODE>token</CODE> - token</DL>
285</DD>
286</DL>
287<HR>
288
289<A NAME="getToken()"><!-- --></A><H3>
290getToken</H3>
291<PRE>
292public java.lang.String <B>getToken</B>()</PRE>
293<DL>
294<DD>Get the string to search for
295<P>
296<DD><DL>
297
298<DT><B>Returns:</B><DD>current token</DL>
299</DD>
300</DL>
301<HR>
302
303<A NAME="setValue(java.lang.String)"><!-- --></A><H3>
304setValue</H3>
305<PRE>
306public void <B>setValue</B>(java.lang.String&nbsp;value)</PRE>
307<DL>
308<DD>The replacement string; required if <code>property<code>
309 is not set
310<P>
311<DD><DL>
312<DT><B>Parameters:</B><DD><CODE>value</CODE> - value to replace</DL>
313</DD>
314</DL>
315<HR>
316
317<A NAME="getValue()"><!-- --></A><H3>
318getValue</H3>
319<PRE>
320public java.lang.String <B>getValue</B>()</PRE>
321<DL>
322<DD>Get replacements string
323<P>
324<DD><DL>
325
326<DT><B>Returns:</B><DD>replacement or null</DL>
327</DD>
328</DL>
329<HR>
330
331<A NAME="setProperty(java.lang.String)"><!-- --></A><H3>
332setProperty</H3>
333<PRE>
334public void <B>setProperty</B>(java.lang.String&nbsp;property)</PRE>
335<DL>
336<DD>Set the name of the property whose value is to serve as
337 the replacement value; required if <code>value</code> is not set.
338<P>
339<DD><DL>
340<DT><B>Parameters:</B><DD><CODE>property</CODE> - propname</DL>
341</DD>
342</DL>
343<HR>
344
345<A NAME="getProperty()"><!-- --></A><H3>
346getProperty</H3>
347<PRE>
348public java.lang.String <B>getProperty</B>()</PRE>
349<DL>
350<DD>Get the name of the property whose value is to serve as
351 the replacement value;
352<P>
353<DD><DL>
354
355<DT><B>Returns:</B><DD>property or null</DL>
356</DD>
357</DL>
358<!-- ========= END OF CLASS DATA ========= -->
359<HR>
360
361
362<!-- ======= START OF BOTTOM NAVBAR ====== -->
363<A NAME="navbar_bottom"><!-- --></A>
364<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
365<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
366<TR>
367<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
368<A NAME="navbar_bottom_firstrow"><!-- --></A>
369<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
370 <TR ALIGN="center" VALIGN="top">
371 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
372 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
373 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
374 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
375 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
376 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
377 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
378 </TR>
379</TABLE>
380</TD>
381<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
382</EM>
383</TD>
384</TR>
385
386<TR>
387<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
388&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
389&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Rmic.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
390<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
391 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
392&nbsp;<A HREF="Replace.Replacefilter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
393&nbsp;<SCRIPT type="text/javascript">
394 <!--
395 if(window==top) {
396 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
397 }
398 //-->
399</SCRIPT>
400<NOSCRIPT>
401 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
402</NOSCRIPT>
403
404</FONT></TD>
405</TR>
406<TR>
407<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
408 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
409<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
410DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
411</TR>
412</TABLE>
413<A NAME="skip-navbar_bottom"></A>
414<!-- ======== END OF BOTTOM NAVBAR ======= -->
415
416<HR>
417Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
418</BODY>
419</HTML>
Note: See TracBrowser for help on using the repository browser.