[14982] | 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 Fri Feb 01 12:53:11 NZDT 2008 -->
|
---|
| 6 | <TITLE>
|
---|
| 7 | Replace (Apache Ant API)
|
---|
| 8 | </TITLE>
|
---|
| 9 |
|
---|
| 10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Replace class">
|
---|
| 11 |
|
---|
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
---|
| 13 |
|
---|
| 14 | <SCRIPT type="text/javascript">
|
---|
| 15 | function windowTitle()
|
---|
| 16 | {
|
---|
| 17 | parent.document.title="Replace (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> </TD>
|
---|
| 36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Rename.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
|
---|
| 53 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.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>
|
---|
| 56 | <A HREF="Replace.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 57 | <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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 74 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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">
|
---|
| 84 | org.apache.tools.ant.taskdefs</FONT>
|
---|
| 85 | <BR>
|
---|
| 86 | Class Replace</H2>
|
---|
| 87 | <PRE>
|
---|
| 88 | java.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"><A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">org.apache.tools.ant.taskdefs.MatchingTask</A>
|
---|
| 92 | <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Replace</B>
|
---|
| 93 | </PRE>
|
---|
| 94 | <DL>
|
---|
| 95 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/types/selectors/SelectorContainer.html" title="interface in org.apache.tools.ant.types.selectors">SelectorContainer</A></DD>
|
---|
| 96 | </DL>
|
---|
| 97 | <HR>
|
---|
| 98 | <DL>
|
---|
| 99 | <DT>public class <B>Replace</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></DL>
|
---|
| 100 |
|
---|
| 101 | <P>
|
---|
| 102 | Replaces all occurrences of one or more string tokens with given
|
---|
| 103 | values in the indicated files. Each value can be either a string
|
---|
| 104 | or the value of a property available in a designated property file.
|
---|
| 105 | If you want to replace a text that crosses line boundaries, you
|
---|
| 106 | must use a nested <code><replacetoken></code> element.
|
---|
| 107 | <P>
|
---|
| 108 |
|
---|
| 109 | <P>
|
---|
| 110 | <DL>
|
---|
| 111 | <DT><B>Since:</B></DT>
|
---|
| 112 | <DD>Ant 1.1</DD>
|
---|
| 113 | </DL>
|
---|
| 114 | <HR>
|
---|
| 115 |
|
---|
| 116 | <P>
|
---|
| 117 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
| 118 |
|
---|
| 119 | <A NAME="nested_class_summary"><!-- --></A>
|
---|
| 120 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 121 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 122 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 123 | <B>Nested Class Summary</B></FONT></TD>
|
---|
| 124 | </TR>
|
---|
| 125 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 126 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 127 | <CODE> class</CODE></FONT></TD>
|
---|
| 128 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs">Replace.NestedString</A></B></CODE>
|
---|
| 129 |
|
---|
| 130 | <BR>
|
---|
| 131 | an inline string to use as the replacement text</TD>
|
---|
| 132 | </TR>
|
---|
| 133 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 134 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 135 | <CODE> class</CODE></FONT></TD>
|
---|
| 136 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html" title="class in org.apache.tools.ant.taskdefs">Replace.Replacefilter</A></B></CODE>
|
---|
| 137 |
|
---|
| 138 | <BR>
|
---|
| 139 | A filter to apply.</TD>
|
---|
| 140 | </TR>
|
---|
| 141 | </TABLE>
|
---|
| 142 |
|
---|
| 143 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
| 144 |
|
---|
| 145 | <A NAME="field_summary"><!-- --></A>
|
---|
| 146 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 147 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 148 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 149 | <B>Field Summary</B></FONT></TD>
|
---|
| 150 | </TR>
|
---|
| 151 | </TABLE>
|
---|
| 152 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask"><!-- --></A>
|
---|
| 153 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 154 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 155 | <TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></B></TD>
|
---|
| 156 | </TR>
|
---|
| 157 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 158 | <TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#fileset">fileset</A></CODE></TD>
|
---|
| 159 | </TR>
|
---|
| 160 | </TABLE>
|
---|
| 161 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
|
---|
| 162 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 163 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 164 | <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>
|
---|
| 165 | </TR>
|
---|
| 166 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 167 | <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>
|
---|
| 168 | </TR>
|
---|
| 169 | </TABLE>
|
---|
| 170 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
|
---|
| 171 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 172 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 173 | <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>
|
---|
| 174 | </TR>
|
---|
| 175 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 176 | <TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
|
---|
| 177 | </TR>
|
---|
| 178 | </TABLE>
|
---|
| 179 |
|
---|
| 180 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
| 181 |
|
---|
| 182 | <A NAME="constructor_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>Constructor Summary</B></FONT></TD>
|
---|
| 187 | </TR>
|
---|
| 188 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 189 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#Replace()">Replace</A></B>()</CODE>
|
---|
| 190 |
|
---|
| 191 | <BR>
|
---|
| 192 | </TD>
|
---|
| 193 | </TR>
|
---|
| 194 | </TABLE>
|
---|
| 195 |
|
---|
| 196 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
| 197 |
|
---|
| 198 | <A NAME="method_summary"><!-- --></A>
|
---|
| 199 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 200 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 201 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
| 202 | <B>Method Summary</B></FONT></TD>
|
---|
| 203 | </TR>
|
---|
| 204 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 206 | <CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html" title="class in org.apache.tools.ant.taskdefs">Replace.Replacefilter</A></CODE></FONT></TD>
|
---|
| 207 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#createReplacefilter()">createReplacefilter</A></B>()</CODE>
|
---|
| 208 |
|
---|
| 209 | <BR>
|
---|
| 210 | Add a nested <replacefilter> element.</TD>
|
---|
| 211 | </TR>
|
---|
| 212 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 214 | <CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs">Replace.NestedString</A></CODE></FONT></TD>
|
---|
| 215 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#createReplaceToken()">createReplaceToken</A></B>()</CODE>
|
---|
| 216 |
|
---|
| 217 | <BR>
|
---|
| 218 | the token to filter as the text of a nested element</TD>
|
---|
| 219 | </TR>
|
---|
| 220 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 221 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 222 | <CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs">Replace.NestedString</A></CODE></FONT></TD>
|
---|
| 223 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#createReplaceValue()">createReplaceValue</A></B>()</CODE>
|
---|
| 224 |
|
---|
| 225 | <BR>
|
---|
| 226 | the string to replace the token as the text of a nested element</TD>
|
---|
| 227 | </TR>
|
---|
| 228 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 229 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 230 | <CODE> void</CODE></FONT></TD>
|
---|
| 231 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#execute()">execute</A></B>()</CODE>
|
---|
| 232 |
|
---|
| 233 | <BR>
|
---|
| 234 | Do the execution.</TD>
|
---|
| 235 | </TR>
|
---|
| 236 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 237 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 238 | <CODE> java.util.Properties</CODE></FONT></TD>
|
---|
| 239 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#getProperties(java.io.File)">getProperties</A></B>(java.io.File propertyFile)</CODE>
|
---|
| 240 |
|
---|
| 241 | <BR>
|
---|
| 242 | helper method to load a properties file and throw a build exception
|
---|
| 243 | if it cannot be loaded</TD>
|
---|
| 244 | </TR>
|
---|
| 245 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 246 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 247 | <CODE> void</CODE></FONT></TD>
|
---|
| 248 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setDir(java.io.File)">setDir</A></B>(java.io.File dir)</CODE>
|
---|
| 249 |
|
---|
| 250 | <BR>
|
---|
| 251 | The base directory to use when replacing a token in multiple files;
|
---|
| 252 | required if <code>file</code> is not defined.</TD>
|
---|
| 253 | </TR>
|
---|
| 254 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 255 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 256 | <CODE> void</CODE></FONT></TD>
|
---|
| 257 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String encoding)</CODE>
|
---|
| 258 |
|
---|
| 259 | <BR>
|
---|
| 260 | Set the file encoding to use on the files read and written by the task;
|
---|
| 261 | optional, defaults to default JVM encoding</TD>
|
---|
| 262 | </TR>
|
---|
| 263 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 264 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 265 | <CODE> void</CODE></FONT></TD>
|
---|
| 266 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setFile(java.io.File)">setFile</A></B>(java.io.File file)</CODE>
|
---|
| 267 |
|
---|
| 268 | <BR>
|
---|
| 269 | Set the source file; required unless <code>dir</code> is set.</TD>
|
---|
| 270 | </TR>
|
---|
| 271 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 272 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 273 | <CODE> void</CODE></FONT></TD>
|
---|
| 274 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setPropertyFile(java.io.File)">setPropertyFile</A></B>(java.io.File filename)</CODE>
|
---|
| 275 |
|
---|
| 276 | <BR>
|
---|
| 277 | The name of a property file from which properties specified using
|
---|
| 278 | nested <code><replacefilter></code> elements are drawn;
|
---|
| 279 | Required only if <i>property</i> attribute of
|
---|
| 280 | <code><replacefilter></code> is used.</TD>
|
---|
| 281 | </TR>
|
---|
| 282 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 283 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 284 | <CODE> void</CODE></FONT></TD>
|
---|
| 285 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setReplaceFilterFile(java.io.File)">setReplaceFilterFile</A></B>(java.io.File filename)</CODE>
|
---|
| 286 |
|
---|
| 287 | <BR>
|
---|
| 288 | Sets the name of a property file containing filters; optional.</TD>
|
---|
| 289 | </TR>
|
---|
| 290 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 291 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 292 | <CODE> void</CODE></FONT></TD>
|
---|
| 293 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setSummary(boolean)">setSummary</A></B>(boolean summary)</CODE>
|
---|
| 294 |
|
---|
| 295 | <BR>
|
---|
| 296 | Indicates whether a summary of the replace operation should be
|
---|
| 297 | produced, detailing how many token occurrences and files were
|
---|
| 298 | processed; optional, default=false</TD>
|
---|
| 299 | </TR>
|
---|
| 300 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 301 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 302 | <CODE> void</CODE></FONT></TD>
|
---|
| 303 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setToken(java.lang.String)">setToken</A></B>(java.lang.String token)</CODE>
|
---|
| 304 |
|
---|
| 305 | <BR>
|
---|
| 306 | Set the string token to replace;
|
---|
| 307 | required unless a nested
|
---|
| 308 | <code>replacetoken</code> element or the <code>replacefilterfile</code>
|
---|
| 309 | attribute is used.</TD>
|
---|
| 310 | </TR>
|
---|
| 311 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 312 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 313 | <CODE> void</CODE></FONT></TD>
|
---|
| 314 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String value)</CODE>
|
---|
| 315 |
|
---|
| 316 | <BR>
|
---|
| 317 | Set the string value to use as token replacement;
|
---|
| 318 | optional, default is the empty string ""</TD>
|
---|
| 319 | </TR>
|
---|
| 320 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 321 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 322 | <CODE> void</CODE></FONT></TD>
|
---|
| 323 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#validateAttributes()">validateAttributes</A></B>()</CODE>
|
---|
| 324 |
|
---|
| 325 | <BR>
|
---|
| 326 | Validate attributes provided for this task in .xml build file.</TD>
|
---|
| 327 | </TR>
|
---|
| 328 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 329 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 330 | <CODE> void</CODE></FONT></TD>
|
---|
| 331 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.html#validateReplacefilters()">validateReplacefilters</A></B>()</CODE>
|
---|
| 332 |
|
---|
| 333 | <BR>
|
---|
| 334 | Validate nested elements.</TD>
|
---|
| 335 | </TR>
|
---|
| 336 | </TABLE>
|
---|
| 337 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask"><!-- --></A>
|
---|
| 338 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 339 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 340 | <TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></B></TD>
|
---|
| 341 | </TR>
|
---|
| 342 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 343 | <TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#add(org.apache.tools.ant.types.selectors.FileSelector)">add</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addAnd(org.apache.tools.ant.types.selectors.AndSelector)">addAnd</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addContains(org.apache.tools.ant.types.selectors.ContainsSelector)">addContains</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addContainsRegexp(org.apache.tools.ant.types.selectors.ContainsRegexpSelector)">addContainsRegexp</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addCustom(org.apache.tools.ant.types.selectors.ExtendSelector)">addCustom</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDate(org.apache.tools.ant.types.selectors.DateSelector)">addDate</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDepend(org.apache.tools.ant.types.selectors.DependSelector)">addDepend</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDepth(org.apache.tools.ant.types.selectors.DepthSelector)">addDepth</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDifferent(org.apache.tools.ant.types.selectors.DifferentSelector)">addDifferent</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addFilename(org.apache.tools.ant.types.selectors.FilenameSelector)">addFilename</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addMajority(org.apache.tools.ant.types.selectors.MajoritySelector)">addMajority</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addModified(org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector)">addModified</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addNone(org.apache.tools.ant.types.selectors.NoneSelector)">addNone</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addNot(org.apache.tools.ant.types.selectors.NotSelector)">addNot</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addOr(org.apache.tools.ant.types.selectors.OrSelector)">addOr</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addPresent(org.apache.tools.ant.types.selectors.PresentSelector)">addPresent</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addSelector(org.apache.tools.ant.types.selectors.SelectSelector)">addSelector</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addSize(org.apache.tools.ant.types.selectors.SizeSelector)">addSize</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addType(org.apache.tools.ant.types.selectors.TypeSelector)">addType</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#appendSelector(org.apache.tools.ant.types.selectors.FileSelector)">appendSelector</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createExclude()">createExclude</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createExcludesFile()">createExcludesFile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createInclude()">createInclude</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createIncludesFile()">createIncludesFile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createPatternSet()">createPatternSet</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getDirectoryScanner(java.io.File)">getDirectoryScanner</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getImplicitFileSet()">getImplicitFileSet</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getSelectors(org.apache.tools.ant.Project)">getSelectors</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#hasSelectors()">hasSelectors</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#selectorCount()">selectorCount</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#selectorElements()">selectorElements</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setCaseSensitive(boolean)">setCaseSensitive</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setDefaultexcludes(boolean)">setDefaultexcludes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setExcludes(java.lang.String)">setExcludes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setExcludesfile(java.io.File)">setExcludesfile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setFollowSymlinks(boolean)">setFollowSymlinks</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setIncludes(java.lang.String)">setIncludes</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setIncludesfile(java.io.File)">setIncludesfile</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setProject(org.apache.tools.ant.Project)">setProject</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#XsetIgnore(java.lang.String)">XsetIgnore</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#XsetItems(java.lang.String)">XsetItems</A></CODE></TD>
|
---|
| 344 | </TR>
|
---|
| 345 | </TABLE>
|
---|
| 346 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
|
---|
| 347 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 348 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 349 | <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>
|
---|
| 350 | </TR>
|
---|
| 351 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 352 | <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>
|
---|
| 353 | </TR>
|
---|
| 354 | </TABLE>
|
---|
| 355 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
|
---|
| 356 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 357 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 358 | <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>
|
---|
| 359 | </TR>
|
---|
| 360 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 361 | <TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A></CODE></TD>
|
---|
| 362 | </TR>
|
---|
| 363 | </TABLE>
|
---|
| 364 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
| 365 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 366 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 367 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
| 368 | </TR>
|
---|
| 369 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 370 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
| 371 | </TR>
|
---|
| 372 | </TABLE>
|
---|
| 373 |
|
---|
| 374 | <P>
|
---|
| 375 |
|
---|
| 376 | <!-- ============ FIELD DETAIL =========== -->
|
---|
| 377 |
|
---|
| 378 |
|
---|
| 379 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
| 380 |
|
---|
| 381 | <A NAME="constructor_detail"><!-- --></A>
|
---|
| 382 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 383 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 384 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 385 | <B>Constructor Detail</B></FONT></TD>
|
---|
| 386 | </TR>
|
---|
| 387 | </TABLE>
|
---|
| 388 |
|
---|
| 389 | <A NAME="Replace()"><!-- --></A><H3>
|
---|
| 390 | Replace</H3>
|
---|
| 391 | <PRE>
|
---|
| 392 | public <B>Replace</B>()</PRE>
|
---|
| 393 | <DL>
|
---|
| 394 | </DL>
|
---|
| 395 |
|
---|
| 396 | <!-- ============ METHOD DETAIL ========== -->
|
---|
| 397 |
|
---|
| 398 | <A NAME="method_detail"><!-- --></A>
|
---|
| 399 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 400 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 401 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
| 402 | <B>Method Detail</B></FONT></TD>
|
---|
| 403 | </TR>
|
---|
| 404 | </TABLE>
|
---|
| 405 |
|
---|
| 406 | <A NAME="execute()"><!-- --></A><H3>
|
---|
| 407 | execute</H3>
|
---|
| 408 | <PRE>
|
---|
| 409 | public void <B>execute</B>()
|
---|
| 410 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
| 411 | <DL>
|
---|
| 412 | <DD>Do the execution.
|
---|
| 413 | <P>
|
---|
| 414 | <DD><DL>
|
---|
| 415 | <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>
|
---|
| 416 | </DD>
|
---|
| 417 | <DD><DL>
|
---|
| 418 |
|
---|
| 419 | <DT><B>Throws:</B>
|
---|
| 420 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if we cant build</DL>
|
---|
| 421 | </DD>
|
---|
| 422 | </DL>
|
---|
| 423 | <HR>
|
---|
| 424 |
|
---|
| 425 | <A NAME="validateAttributes()"><!-- --></A><H3>
|
---|
| 426 | validateAttributes</H3>
|
---|
| 427 | <PRE>
|
---|
| 428 | public void <B>validateAttributes</B>()
|
---|
| 429 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
| 430 | <DL>
|
---|
| 431 | <DD>Validate attributes provided for this task in .xml build file.
|
---|
| 432 | <P>
|
---|
| 433 | <DD><DL>
|
---|
| 434 |
|
---|
| 435 | <DT><B>Throws:</B>
|
---|
| 436 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any supplied attribute is invalid or any
|
---|
| 437 | mandatory attribute is missing</DL>
|
---|
| 438 | </DD>
|
---|
| 439 | </DL>
|
---|
| 440 | <HR>
|
---|
| 441 |
|
---|
| 442 | <A NAME="validateReplacefilters()"><!-- --></A><H3>
|
---|
| 443 | validateReplacefilters</H3>
|
---|
| 444 | <PRE>
|
---|
| 445 | public void <B>validateReplacefilters</B>()
|
---|
| 446 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
| 447 | <DL>
|
---|
| 448 | <DD>Validate nested elements.
|
---|
| 449 | <P>
|
---|
| 450 | <DD><DL>
|
---|
| 451 |
|
---|
| 452 | <DT><B>Throws:</B>
|
---|
| 453 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any supplied attribute is invalid or any
|
---|
| 454 | mandatory attribute is missing</DL>
|
---|
| 455 | </DD>
|
---|
| 456 | </DL>
|
---|
| 457 | <HR>
|
---|
| 458 |
|
---|
| 459 | <A NAME="getProperties(java.io.File)"><!-- --></A><H3>
|
---|
| 460 | getProperties</H3>
|
---|
| 461 | <PRE>
|
---|
| 462 | public java.util.Properties <B>getProperties</B>(java.io.File propertyFile)
|
---|
| 463 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
| 464 | <DL>
|
---|
| 465 | <DD>helper method to load a properties file and throw a build exception
|
---|
| 466 | if it cannot be loaded
|
---|
| 467 | <P>
|
---|
| 468 | <DD><DL>
|
---|
| 469 | <DT><B>Parameters:</B><DD><CODE>propertyFile</CODE> - the file to load the properties from
|
---|
| 470 | <DT><B>Returns:</B><DD>loaded properties collection
|
---|
| 471 | <DT><B>Throws:</B>
|
---|
| 472 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the file could not be found or read</DL>
|
---|
| 473 | </DD>
|
---|
| 474 | </DL>
|
---|
| 475 | <HR>
|
---|
| 476 |
|
---|
| 477 | <A NAME="setFile(java.io.File)"><!-- --></A><H3>
|
---|
| 478 | setFile</H3>
|
---|
| 479 | <PRE>
|
---|
| 480 | public void <B>setFile</B>(java.io.File file)</PRE>
|
---|
| 481 | <DL>
|
---|
| 482 | <DD>Set the source file; required unless <code>dir</code> is set.
|
---|
| 483 | <P>
|
---|
| 484 | <DD><DL>
|
---|
| 485 | <DT><B>Parameters:</B><DD><CODE>file</CODE> - source file</DL>
|
---|
| 486 | </DD>
|
---|
| 487 | </DL>
|
---|
| 488 | <HR>
|
---|
| 489 |
|
---|
| 490 | <A NAME="setSummary(boolean)"><!-- --></A><H3>
|
---|
| 491 | setSummary</H3>
|
---|
| 492 | <PRE>
|
---|
| 493 | public void <B>setSummary</B>(boolean summary)</PRE>
|
---|
| 494 | <DL>
|
---|
| 495 | <DD>Indicates whether a summary of the replace operation should be
|
---|
| 496 | produced, detailing how many token occurrences and files were
|
---|
| 497 | processed; optional, default=false
|
---|
| 498 | <P>
|
---|
| 499 | <DD><DL>
|
---|
| 500 | <DT><B>Parameters:</B><DD><CODE>summary</CODE> - true if you would like a summary logged of the
|
---|
| 501 | replace operation</DL>
|
---|
| 502 | </DD>
|
---|
| 503 | </DL>
|
---|
| 504 | <HR>
|
---|
| 505 |
|
---|
| 506 | <A NAME="setReplaceFilterFile(java.io.File)"><!-- --></A><H3>
|
---|
| 507 | setReplaceFilterFile</H3>
|
---|
| 508 | <PRE>
|
---|
| 509 | public void <B>setReplaceFilterFile</B>(java.io.File filename)</PRE>
|
---|
| 510 | <DL>
|
---|
| 511 | <DD>Sets the name of a property file containing filters; optional.
|
---|
| 512 | Each property will be treated as a
|
---|
| 513 | replacefilter where token is the name of the property and value
|
---|
| 514 | is the value of the property.
|
---|
| 515 | <P>
|
---|
| 516 | <DD><DL>
|
---|
| 517 | <DT><B>Parameters:</B><DD><CODE>filename</CODE> - file to load</DL>
|
---|
| 518 | </DD>
|
---|
| 519 | </DL>
|
---|
| 520 | <HR>
|
---|
| 521 |
|
---|
| 522 | <A NAME="setDir(java.io.File)"><!-- --></A><H3>
|
---|
| 523 | setDir</H3>
|
---|
| 524 | <PRE>
|
---|
| 525 | public void <B>setDir</B>(java.io.File dir)</PRE>
|
---|
| 526 | <DL>
|
---|
| 527 | <DD>The base directory to use when replacing a token in multiple files;
|
---|
| 528 | required if <code>file</code> is not defined.
|
---|
| 529 | <P>
|
---|
| 530 | <DD><DL>
|
---|
| 531 | <DT><B>Parameters:</B><DD><CODE>dir</CODE> - base dir</DL>
|
---|
| 532 | </DD>
|
---|
| 533 | </DL>
|
---|
| 534 | <HR>
|
---|
| 535 |
|
---|
| 536 | <A NAME="setToken(java.lang.String)"><!-- --></A><H3>
|
---|
| 537 | setToken</H3>
|
---|
| 538 | <PRE>
|
---|
| 539 | public void <B>setToken</B>(java.lang.String token)</PRE>
|
---|
| 540 | <DL>
|
---|
| 541 | <DD>Set the string token to replace;
|
---|
| 542 | required unless a nested
|
---|
| 543 | <code>replacetoken</code> element or the <code>replacefilterfile</code>
|
---|
| 544 | attribute is used.
|
---|
| 545 | <P>
|
---|
| 546 | <DD><DL>
|
---|
| 547 | <DT><B>Parameters:</B><DD><CODE>token</CODE> - token string</DL>
|
---|
| 548 | </DD>
|
---|
| 549 | </DL>
|
---|
| 550 | <HR>
|
---|
| 551 |
|
---|
| 552 | <A NAME="setValue(java.lang.String)"><!-- --></A><H3>
|
---|
| 553 | setValue</H3>
|
---|
| 554 | <PRE>
|
---|
| 555 | public void <B>setValue</B>(java.lang.String value)</PRE>
|
---|
| 556 | <DL>
|
---|
| 557 | <DD>Set the string value to use as token replacement;
|
---|
| 558 | optional, default is the empty string ""
|
---|
| 559 | <P>
|
---|
| 560 | <DD><DL>
|
---|
| 561 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - replacement value</DL>
|
---|
| 562 | </DD>
|
---|
| 563 | </DL>
|
---|
| 564 | <HR>
|
---|
| 565 |
|
---|
| 566 | <A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
|
---|
| 567 | setEncoding</H3>
|
---|
| 568 | <PRE>
|
---|
| 569 | public void <B>setEncoding</B>(java.lang.String encoding)</PRE>
|
---|
| 570 | <DL>
|
---|
| 571 | <DD>Set the file encoding to use on the files read and written by the task;
|
---|
| 572 | optional, defaults to default JVM encoding
|
---|
| 573 | <P>
|
---|
| 574 | <DD><DL>
|
---|
| 575 | <DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the encoding to use on the files</DL>
|
---|
| 576 | </DD>
|
---|
| 577 | </DL>
|
---|
| 578 | <HR>
|
---|
| 579 |
|
---|
| 580 | <A NAME="createReplaceToken()"><!-- --></A><H3>
|
---|
| 581 | createReplaceToken</H3>
|
---|
| 582 | <PRE>
|
---|
| 583 | public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs">Replace.NestedString</A> <B>createReplaceToken</B>()</PRE>
|
---|
| 584 | <DL>
|
---|
| 585 | <DD>the token to filter as the text of a nested element
|
---|
| 586 | <P>
|
---|
| 587 | <DD><DL>
|
---|
| 588 |
|
---|
| 589 | <DT><B>Returns:</B><DD>nested token to configure</DL>
|
---|
| 590 | </DD>
|
---|
| 591 | </DL>
|
---|
| 592 | <HR>
|
---|
| 593 |
|
---|
| 594 | <A NAME="createReplaceValue()"><!-- --></A><H3>
|
---|
| 595 | createReplaceValue</H3>
|
---|
| 596 | <PRE>
|
---|
| 597 | public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs">Replace.NestedString</A> <B>createReplaceValue</B>()</PRE>
|
---|
| 598 | <DL>
|
---|
| 599 | <DD>the string to replace the token as the text of a nested element
|
---|
| 600 | <P>
|
---|
| 601 | <DD><DL>
|
---|
| 602 |
|
---|
| 603 | <DT><B>Returns:</B><DD>replacement value to configure</DL>
|
---|
| 604 | </DD>
|
---|
| 605 | </DL>
|
---|
| 606 | <HR>
|
---|
| 607 |
|
---|
| 608 | <A NAME="setPropertyFile(java.io.File)"><!-- --></A><H3>
|
---|
| 609 | setPropertyFile</H3>
|
---|
| 610 | <PRE>
|
---|
| 611 | public void <B>setPropertyFile</B>(java.io.File filename)</PRE>
|
---|
| 612 | <DL>
|
---|
| 613 | <DD>The name of a property file from which properties specified using
|
---|
| 614 | nested <code><replacefilter></code> elements are drawn;
|
---|
| 615 | Required only if <i>property</i> attribute of
|
---|
| 616 | <code><replacefilter></code> is used.
|
---|
| 617 | <P>
|
---|
| 618 | <DD><DL>
|
---|
| 619 | <DT><B>Parameters:</B><DD><CODE>filename</CODE> - file to load</DL>
|
---|
| 620 | </DD>
|
---|
| 621 | </DL>
|
---|
| 622 | <HR>
|
---|
| 623 |
|
---|
| 624 | <A NAME="createReplacefilter()"><!-- --></A><H3>
|
---|
| 625 | createReplacefilter</H3>
|
---|
| 626 | <PRE>
|
---|
| 627 | public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.Replacefilter.html" title="class in org.apache.tools.ant.taskdefs">Replace.Replacefilter</A> <B>createReplacefilter</B>()</PRE>
|
---|
| 628 | <DL>
|
---|
| 629 | <DD>Add a nested <replacefilter> element.
|
---|
| 630 | <P>
|
---|
| 631 | <DD><DL>
|
---|
| 632 |
|
---|
| 633 | <DT><B>Returns:</B><DD>a nested ReplaceFilter object to be configured</DL>
|
---|
| 634 | </DD>
|
---|
| 635 | </DL>
|
---|
| 636 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
| 637 | <HR>
|
---|
| 638 |
|
---|
| 639 |
|
---|
| 640 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
| 641 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
| 642 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
| 643 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
| 644 | <TR>
|
---|
| 645 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
| 646 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
| 647 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
| 648 | <TR ALIGN="center" VALIGN="top">
|
---|
| 649 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
| 650 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 651 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 652 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 653 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 654 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 655 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
| 656 | </TR>
|
---|
| 657 | </TABLE>
|
---|
| 658 | </TD>
|
---|
| 659 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
| 660 | </EM>
|
---|
| 661 | </TD>
|
---|
| 662 | </TR>
|
---|
| 663 |
|
---|
| 664 | <TR>
|
---|
| 665 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 666 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Rename.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
|
---|
| 667 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Replace.NestedString.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
| 668 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 669 | <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
| 670 | <A HREF="Replace.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 671 | <SCRIPT type="text/javascript">
|
---|
| 672 | <!--
|
---|
| 673 | if(window==top) {
|
---|
| 674 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
| 675 | }
|
---|
| 676 | //-->
|
---|
| 677 | </SCRIPT>
|
---|
| 678 | <NOSCRIPT>
|
---|
| 679 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
| 680 | </NOSCRIPT>
|
---|
| 681 |
|
---|
| 682 | </FONT></TD>
|
---|
| 683 | </TR>
|
---|
| 684 | <TR>
|
---|
| 685 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 686 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 687 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 688 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
| 689 | </TR>
|
---|
| 690 | </TABLE>
|
---|
| 691 | <A NAME="skip-navbar_bottom"></A>
|
---|
| 692 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
| 693 |
|
---|
| 694 | <HR>
|
---|
| 695 | Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.
|
---|
| 696 | </BODY>
|
---|
| 697 | </HTML>
|
---|