org.gjt.sp.jedit.search
Interface SearchMatcher

All Known Implementing Classes:
BoyerMooreSearchMatcher, RESearchMatcher

public interface SearchMatcher

An abstract interface for matching strings.

Version:
$Id: SearchMatcher.java,v 1.8 2003/01/12 03:08:25 spestov Exp $
Author:
Slava Pestov

Method Summary
 int[] nextMatch(CharIndexed text, boolean start, boolean end, boolean firstTime, boolean reverse)
          Returns the offset of the first match of the specified text within this matcher.
 java.lang.String substitute(java.lang.String text)
          Returns the specified text, with any substitution specified within this matcher performed.
 

Method Detail

nextMatch

public int[] nextMatch(CharIndexed text,
                       boolean start,
                       boolean end,
                       boolean firstTime,
                       boolean reverse)
Returns the offset of the first match of the specified text within this matcher.

Parameters:
text - The text to search in
start - True if the start of the segment is the beginning of the buffer
end - True if the end of the segment is the end of the buffer
firstTime - If false and the search string matched at the start offset with length zero, automatically find next match
reverse - If true, searching will be performed in a backward direction.
Returns:
an array where the first element is the start offset of the match, and the second element is the end offset of the match
Since:
jEdit 4.1pre7

substitute

public java.lang.String substitute(java.lang.String text)
                            throws java.lang.Exception
Returns the specified text, with any substitution specified within this matcher performed.

Parameters:
text - The text
Returns:
The changed string
java.lang.Exception