source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/util/regexp/Regexp.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.0 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:35 NZST 2007 -->
6<TITLE>
7Regexp (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.regexp.Regexp interface">
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="Regexp (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;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html" title="interface in org.apache.tools.ant.util.regexp"><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="Regexp.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="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&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.util.regexp</FONT>
85<BR>
86Interface Regexp</H2>
87<DL>
88<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html" title="interface in org.apache.tools.ant.util.regexp">RegexpMatcher</A></DD>
89</DL>
90<DL>
91<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/util/regexp/JakartaOroRegexp.html" title="class in org.apache.tools.ant.util.regexp">JakartaOroRegexp</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.html" title="class in org.apache.tools.ant.util.regexp">JakartaRegexpRegexp</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.html" title="class in org.apache.tools.ant.util.regexp">Jdk14RegexpRegexp</A></DD>
92</DL>
93<HR>
94<DL>
95<DT>public interface <B>Regexp</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html" title="interface in org.apache.tools.ant.util.regexp">RegexpMatcher</A></DL>
96
97<P>
98Interface which represents a regular expression, and the operations
99 that can be performed on it.
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108
109<!-- =========== FIELD SUMMARY =========== -->
110
111<A NAME="field_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TD COLSPAN=2><FONT SIZE="+2">
115<B>Field Summary</B></FONT></TD>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>static&nbsp;int</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/regexp/Regexp.html#REPLACE_ALL">REPLACE_ALL</A></B></CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replace all occurances of the regular expression</TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>static&nbsp;int</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/regexp/Regexp.html#REPLACE_FIRST">REPLACE_FIRST</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replace only the first occurance of the regular expression</TD>
132</TR>
133</TABLE>
134&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.util.regexp.RegexpMatcher"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
137<TD><B>Fields inherited from interface org.apache.tools.ant.util.regexp.<A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html" title="interface in org.apache.tools.ant.util.regexp">RegexpMatcher</A></B></TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#MATCH_CASE_INSENSITIVE">MATCH_CASE_INSENSITIVE</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#MATCH_DEFAULT">MATCH_DEFAULT</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#MATCH_MULTILINE">MATCH_MULTILINE</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#MATCH_SINGLELINE">MATCH_SINGLELINE</A></CODE></TD>
141</TR>
142</TABLE>
143&nbsp;
144<!-- ======== CONSTRUCTOR SUMMARY ======== -->
145
146
147<!-- ========== METHOD SUMMARY =========== -->
148
149<A NAME="method_summary"><!-- --></A>
150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
152<TD COLSPAN=2><FONT SIZE="+2">
153<B>Method Summary</B></FONT></TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/regexp/Regexp.html#substitute(java.lang.String, java.lang.String, int)">substitute</A></B>(java.lang.String&nbsp;input,
159 java.lang.String&nbsp;argument,
160 int&nbsp;options)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Perform a substitution on the regular expression.</TD>
164</TR>
165</TABLE>
166&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.util.regexp.RegexpMatcher"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
169<TD><B>Methods inherited from interface org.apache.tools.ant.util.regexp.<A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html" title="interface in org.apache.tools.ant.util.regexp">RegexpMatcher</A></B></TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#getGroups(java.lang.String)">getGroups</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#getGroups(java.lang.String, int)">getGroups</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#getPattern()">getPattern</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#matches(java.lang.String)">matches</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#matches(java.lang.String, int)">matches</A>, <A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html#setPattern(java.lang.String)">setPattern</A></CODE></TD>
173</TR>
174</TABLE>
175&nbsp;
176<P>
177
178<!-- ============ FIELD DETAIL =========== -->
179
180<A NAME="field_detail"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183<TD COLSPAN=1><FONT SIZE="+2">
184<B>Field Detail</B></FONT></TD>
185</TR>
186</TABLE>
187
188<A NAME="REPLACE_FIRST"><!-- --></A><H3>
189REPLACE_FIRST</H3>
190<PRE>
191public static final int <B>REPLACE_FIRST</B></PRE>
192<DL>
193<DD>Replace only the first occurance of the regular expression
194<P>
195<DL>
196<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.util.regexp.Regexp.REPLACE_FIRST">Constant Field Values</A></DL>
197</DL>
198<HR>
199
200<A NAME="REPLACE_ALL"><!-- --></A><H3>
201REPLACE_ALL</H3>
202<PRE>
203public static final int <B>REPLACE_ALL</B></PRE>
204<DL>
205<DD>Replace all occurances of the regular expression
206<P>
207<DL>
208<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.util.regexp.Regexp.REPLACE_ALL">Constant Field Values</A></DL>
209</DL>
210
211<!-- ========= CONSTRUCTOR DETAIL ======== -->
212
213
214<!-- ============ METHOD DETAIL ========== -->
215
216<A NAME="method_detail"><!-- --></A>
217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
219<TD COLSPAN=1><FONT SIZE="+2">
220<B>Method Detail</B></FONT></TD>
221</TR>
222</TABLE>
223
224<A NAME="substitute(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
225substitute</H3>
226<PRE>
227public java.lang.String <B>substitute</B>(java.lang.String&nbsp;input,
228 java.lang.String&nbsp;argument,
229 int&nbsp;options)
230 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
231<DL>
232<DD>Perform a substitution on the regular expression.
233<P>
234<DD><DL>
235</DL>
236</DD>
237<DD><DL>
238<DT><B>Parameters:</B><DD><CODE>input</CODE> - The string to substitute on<DD><CODE>argument</CODE> - The string which defines the substitution<DD><CODE>options</CODE> - The list of options for the match and replace. See the
239 MATCH_ and REPLACE_ constants above.
240<DT><B>Returns:</B><DD>the result of the operation
241<DT><B>Throws:</B>
242<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - on error</DL>
243</DD>
244</DL>
245<!-- ========= END OF CLASS DATA ========= -->
246<HR>
247
248
249<!-- ======= START OF BOTTOM NAVBAR ====== -->
250<A NAME="navbar_bottom"><!-- --></A>
251<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
252<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
253<TR>
254<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
255<A NAME="navbar_bottom_firstrow"><!-- --></A>
256<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
257 <TR ALIGN="center" VALIGN="top">
258 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
259 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
260 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
261 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
262 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
263 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
264 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
265 </TR>
266</TABLE>
267</TD>
268<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
269</EM>
270</TD>
271</TR>
272
273<TR>
274<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
275&nbsp;PREV CLASS&nbsp;
276&nbsp;<A HREF="../../../../../../org/apache/tools/ant/util/regexp/RegexpMatcher.html" title="interface in org.apache.tools.ant.util.regexp"><B>NEXT CLASS</B></A></FONT></TD>
277<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
278 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
279&nbsp;<A HREF="Regexp.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
280&nbsp;<SCRIPT type="text/javascript">
281 <!--
282 if(window==top) {
283 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
284 }
285 //-->
286</SCRIPT>
287<NOSCRIPT>
288 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
289</NOSCRIPT>
290
291</FONT></TD>
292</TR>
293<TR>
294<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
295 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
296<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
297DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
298</TR>
299</TABLE>
300<A NAME="skip-navbar_bottom"></A>
301<!-- ======== END OF BOTTOM NAVBAR ======= -->
302
303<HR>
304Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
305</BODY>
306</HTML>
Note: See TracBrowser for help on using the repository browser.