/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/search/PatternSearchMatcher.html
# · HTML · 385 lines · 330 code · 41 blank · 14 comment · 0 complexity · 78f7decae5b178d61ad3379581063e8c MD5 · raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:12 GMT-08:00 2008 -->
- <TITLE>
- PatternSearchMatcher (jEdit API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.gjt.sp.jedit.search.PatternSearchMatcher class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" >
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PatternSearchMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../org/gjt/sp/jedit/search/HyperSearchTreeNodeCallback.html" title="interface in org.gjt.sp.jedit.search"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/gjt/sp/jedit/search/SearchAndReplace.html" title="class in org.gjt.sp.jedit.search"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/gjt/sp/jedit/search/PatternSearchMatcher.html" target="_top"><B>FRAMES</B></A>
- <A HREF="PatternSearchMatcher.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.gjt.sp.jedit.search.SearchMatcher">NESTED</A> | <A HREF="#fields_inherited_from_class_org.gjt.sp.jedit.search.SearchMatcher">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.gjt.sp.jedit.search</FONT>
- <BR>
- Class PatternSearchMatcher</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html" title="class in org.gjt.sp.jedit.search">org.gjt.sp.jedit.search.SearchMatcher</A>
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.search.PatternSearchMatcher</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE>public class <B>PatternSearchMatcher</B><DT>extends <A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html" title="class in org.gjt.sp.jedit.search">SearchMatcher</A></DL>
- </PRE>
- <P>
- A regular expression string matcher using java.util.regex.
- <P>
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre5</DD>
- <DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
- <HR>
- <P>
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <A NAME="nested_class_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Nested Class Summary</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="nested_classes_inherited_from_class_org.gjt.sp.jedit.search.SearchMatcher"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.gjt.sp.jedit.search.<A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html" title="class in org.gjt.sp.jedit.search">SearchMatcher</A></B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A></CODE></TD>
- </TR>
- </TABLE>
-
- <!-- =========== FIELD SUMMARY =========== -->
- <A NAME="field_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Field Summary</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="fields_inherited_from_class_org.gjt.sp.jedit.search.SearchMatcher"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Fields inherited from class org.gjt.sp.jedit.search.<A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html" title="class in org.gjt.sp.jedit.search">SearchMatcher</A></B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#returnValue">returnValue</A></CODE></TD>
- </TR>
- </TABLE>
-
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/PatternSearchMatcher.html#PatternSearchMatcher(java.util.regex.Pattern, boolean)">PatternSearchMatcher</A></B>(java.util.regex.Pattern re,
- boolean ignoreCase)</CODE>
- <BR>
- Creates a new regular expression already compiled.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/PatternSearchMatcher.html#PatternSearchMatcher(java.lang.String, boolean)">PatternSearchMatcher</A></B>(java.lang.String search,
- boolean ignoreCase)</CODE>
- <BR>
- Creates a new regular expression string matcher.</TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/PatternSearchMatcher.html#isMatchingEOL()">isMatchingEOL</A></B>()</CODE>
- <BR>
- Returns whether the matcher is matching the end of the line
- character.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search">SearchMatcher.Match</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/PatternSearchMatcher.html#nextMatch(java.lang.CharSequence, boolean, boolean, boolean, boolean)">nextMatch</A></B>(java.lang.CharSequence text,
- boolean start,
- boolean end,
- boolean firstTime,
- boolean reverse)</CODE>
- <BR>
- Returns the offset of the first match of the specified text
- within this matcher.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/search/PatternSearchMatcher.html#toString()">toString</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="PatternSearchMatcher(java.lang.String, boolean)"><!-- --></A><H3>
- PatternSearchMatcher</H3>
- <PRE>
- public <B>PatternSearchMatcher</B>(java.lang.String search,
- boolean ignoreCase)</PRE>
- <DL>
- <DD>Creates a new regular expression string matcher.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>search</CODE> - the search pattern<DD><CODE>ignoreCase</CODE> - <code>true</code> if you want to ignore case<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre5</DD>
- <DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
- </DL>
- <HR>
- <A NAME="PatternSearchMatcher(java.util.regex.Pattern, boolean)"><!-- --></A><H3>
- PatternSearchMatcher</H3>
- <PRE>
- public <B>PatternSearchMatcher</B>(java.util.regex.Pattern re,
- boolean ignoreCase)</PRE>
- <DL>
- <DD>Creates a new regular expression already compiled.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>re</CODE> - the compiled regex<DD><CODE>ignoreCase</CODE> - <code>true</code> if you want to ignore case<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre13</DD>
- <DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
- </DL>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="nextMatch(java.lang.CharSequence, boolean, boolean, boolean, boolean)"><!-- --></A><H3>
- nextMatch</H3>
- <PRE>
- public <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 text,
- boolean start,
- boolean end,
- boolean firstTime,
- boolean reverse)</PRE>
- <DL>
- <DD>Returns the offset of the first match of the specified text
- within this matcher.
- <P>
- <DD><DL>
- <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#nextMatch(java.lang.CharSequence, boolean, boolean, boolean, boolean)">nextMatch</A></CODE> in class <CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html" title="class in org.gjt.sp.jedit.search">SearchMatcher</A></CODE></DL>
- </DD>
- <DD><DL>
- <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 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 offset with length zero, automatically
- find next match<DD><CODE>reverse</CODE> - Unsupported for PatternSearchMatcher. Should
- always be "false".
- <DT><B>Returns:</B><DD>A <A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.Match.html" title="class in org.gjt.sp.jedit.search"><CODE>SearchMatcher.Match</CODE></A> object.<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isMatchingEOL()"><!-- --></A><H3>
- isMatchingEOL</H3>
- <PRE>
- public boolean <B>isMatchingEOL</B>()</PRE>
- <DL>
- <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#isMatchingEOL()">SearchMatcher</A></CODE></B></DD>
- <DD>Returns whether the matcher is matching the end of the line
- character. This should be used to adjust the matched region
- size when matching the end-of-line character, since it's not
- included in the matched region returned by the
- java.util.regex.Pattern matcher.
- <P>
- <DD><DL>
- <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html#isMatchingEOL()">isMatchingEOL</A></CODE> in class <CODE><A HREF="../../../../../org/gjt/sp/jedit/search/SearchMatcher.html" title="class in org.gjt.sp.jedit.search">SearchMatcher</A></CODE></DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>Whether the end of the match region will be the EOL
- character.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="toString()"><!-- --></A><H3>
- toString</H3>
- <PRE>
- public java.lang.String <B>toString</B>()</PRE>
- <DL>
- <DD><DL>
- <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PatternSearchMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../org/gjt/sp/jedit/search/HyperSearchTreeNodeCallback.html" title="interface in org.gjt.sp.jedit.search"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/gjt/sp/jedit/search/SearchAndReplace.html" title="class in org.gjt.sp.jedit.search"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/gjt/sp/jedit/search/PatternSearchMatcher.html" target="_top"><B>FRAMES</B></A>
- <A HREF="PatternSearchMatcher.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.gjt.sp.jedit.search.SearchMatcher">NESTED</A> | <A HREF="#fields_inherited_from_class_org.gjt.sp.jedit.search.SearchMatcher">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- </BODY>
- </HTML>