PageRenderTime 71ms CodeModel.GetById 47ms app.highlight 18ms RepoModel.GetById 1ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/search/SearchMatcher.html

#
HTML | 342 lines | 286 code | 42 blank | 14 comment | 0 complexity | 395fd1d420739d7e79e4a8c2abc02b43 MD5 | raw file
  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.5.0_14) on Tue Jul 22 07:14:13 GMT-08:00 2008 -->
  6<TITLE>
  7SearchMatcher (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.search.SearchMatcher class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SearchMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/SearchFileSet.html" title="interface in org.gjt.sp.jedit.search"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../../index.html?org/gjt/sp/jedit/search/SearchMatcher.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="SearchMatcher.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit.search</FONT>
 78<BR>
 79Class SearchMatcher</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.search.SearchMatcher</B>
 83</PRE>
 84<DL>
 85<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/search/BoyerMooreSearchMatcher.html" title="class in org.gjt.sp.jedit.search">BoyerMooreSearchMatcher</A>, <A HREF="../../../../../org/gjt/sp/jedit/search/PatternSearchMatcher.html" title="class in org.gjt.sp.jedit.search">PatternSearchMatcher</A></DD>
 86</DL>
 87<HR>
 88<DL>
 89<DT><PRE>public abstract class <B>SearchMatcher</B><DT>extends java.lang.Object</DL>
 90</PRE>
 91
 92<P>
 93An abstract class for matching strings.
 94<P>
 95
 96<P>
 97<HR>
 98
 99<P>
100<!-- ======== NESTED CLASS SUMMARY ======== -->
101
102<A NAME="nested_class_summary"><!-- --></A>
103<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
104<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
105<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
106<B>Nested Class Summary</B></FONT></TH>
107</TR>
108<TR BGCOLOR="white" CLASS="TableRowColor">
109<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
110<CODE>static&nbsp;class</CODE></FONT></TD>
111<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A></B></CODE>
112
113<BR>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
115</TR>
116</TABLE>
117&nbsp;<!-- =========== FIELD SUMMARY =========== -->
118
119<A NAME="field_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123<B>Field Summary</B></FONT></TH>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>protected &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A></CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#returnValue">returnValue</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
132</TR>
133</TABLE>
134&nbsp;
135<!-- ======== CONSTRUCTOR SUMMARY ======== -->
136
137<A NAME="constructor_summary"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141<B>Constructor Summary</B></FONT></TH>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#SearchMatcher()">SearchMatcher</A></B>()</CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148</TR>
149</TABLE>
150&nbsp;
151<!-- ========== METHOD SUMMARY =========== -->
152
153<A NAME="method_summary"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
156<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
157<B>Method Summary</B></FONT></TH>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;boolean</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#isMatchingEOL()">isMatchingEOL</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the matcher is matching the end of the line
166 character.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>abstract &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A></CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#nextMatch(java.lang.CharSequence, boolean, boolean, boolean, boolean)">nextMatch</A></B>(java.lang.CharSequence&nbsp;text,
172          boolean&nbsp;start,
173          boolean&nbsp;end,
174          boolean&nbsp;firstTime,
175          boolean&nbsp;reverse)</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the offset of the first match of the specified text
179 within this matcher.</TD>
180</TR>
181</TABLE>
182&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
185<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
189</TR>
190</TABLE>
191&nbsp;
192<P>
193
194<!-- ============ FIELD DETAIL =========== -->
195
196<A NAME="field_detail"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
200<B>Field Detail</B></FONT></TH>
201</TR>
202</TABLE>
203
204<A NAME="returnValue"><!-- --></A><H3>
205returnValue</H3>
206<PRE>
207protected <A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A> <B>returnValue</B></PRE>
208<DL>
209<DL>
210</DL>
211</DL>
212
213<!-- ========= CONSTRUCTOR DETAIL ======== -->
214
215<A NAME="constructor_detail"><!-- --></A>
216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
218<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
219<B>Constructor Detail</B></FONT></TH>
220</TR>
221</TABLE>
222
223<A NAME="SearchMatcher()"><!-- --></A><H3>
224SearchMatcher</H3>
225<PRE>
226public <B>SearchMatcher</B>()</PRE>
227<DL>
228</DL>
229
230<!-- ============ METHOD DETAIL ========== -->
231
232<A NAME="method_detail"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
235<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
236<B>Method Detail</B></FONT></TH>
237</TR>
238</TABLE>
239
240<A NAME="nextMatch(java.lang.CharSequence, boolean, boolean, boolean, boolean)"><!-- --></A><H3>
241nextMatch</H3>
242<PRE>
243public abstract <A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A> <B>nextMatch</B>(java.lang.CharSequence&nbsp;text,
244                                              boolean&nbsp;start,
245                                              boolean&nbsp;end,
246                                              boolean&nbsp;firstTime,
247                                              boolean&nbsp;reverse)</PRE>
248<DL>
249<DD>Returns the offset of the first match of the specified text
250 within this matcher.
251<P>
252<DD><DL>
253<DT><B>Parameters:</B><DD><CODE>text</CODE> - The text to search in<DD><CODE>start</CODE> - True if the start of the segment is the beginning of the
254 buffer<DD><CODE>end</CODE> - True if the end of the segment is the end of the buffer<DD><CODE>firstTime</CODE> - If false and the search string matched at the start
255 offset with length zero, automatically find next match<DD><CODE>reverse</CODE> - If true, searching will be performed in a backward
256 direction.
257<DT><B>Returns:</B><DD>an array where the first element is the start offset
258 of the match, and the second element is the end offset of
259 the match<DT><B>Since:</B></DT>
260  <DD>jEdit 4.3pre5</DD>
261</DL>
262</DD>
263</DL>
264<HR>
265
266<A NAME="isMatchingEOL()"><!-- --></A><H3>
267isMatchingEOL</H3>
268<PRE>
269public boolean <B>isMatchingEOL</B>()</PRE>
270<DL>
271<DD>Returns whether the matcher is matching the end of the line
272 character. This should be used to adjust the matched region
273 size when matching the end-of-line character, since it's not
274 included in the matched region returned by the
275 java.util.regex.Pattern matcher.
276<P>
277<DD><DL>
278
279<DT><B>Returns:</B><DD>Whether the end of the match region will be the EOL
280         character.<DT><B>Since:</B></DT>
281  <DD>jEdit 4.3pre7</DD>
282</DL>
283</DD>
284</DL>
285<!-- ========= END OF CLASS DATA ========= -->
286<HR>
287
288
289<!-- ======= START OF BOTTOM NAVBAR ====== -->
290<A NAME="navbar_bottom"><!-- --></A>
291<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
292<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
293<TR>
294<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
295<A NAME="navbar_bottom_firstrow"><!-- --></A>
296<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
297  <TR ALIGN="center" VALIGN="top">
298  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
299  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
300  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
301  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SearchMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
302  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
303  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
304  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
305  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
306  </TR>
307</TABLE>
308</TD>
309<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
310</EM>
311</TD>
312</TR>
313
314<TR>
315<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
316&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/SearchFileSet.html" title="interface in org.gjt.sp.jedit.search"><B>PREV CLASS</B></A>&nbsp;
317&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search"><B>NEXT CLASS</B></A></FONT></TD>
318<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
319  <A HREF="../../../../../index.html?org/gjt/sp/jedit/search/SearchMatcher.html" target="_top"><B>FRAMES</B></A>  &nbsp;
320&nbsp;<A HREF="SearchMatcher.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
321&nbsp;
322<NOSCRIPT>
323  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
324</NOSCRIPT>
325
326
327</FONT></TD>
328</TR>
329<TR>
330<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
331  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
332<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
333DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
334</TR>
335</TABLE>
336<A NAME="skip-navbar_bottom"></A>
337<!-- ======== END OF BOTTOM NAVBAR ======= -->
338
339<HR>
340
341</BODY>
342</HTML>