/jEdit/tags/jedit-4-0-pre3/org/gjt/sp/jedit/search/SearchMatcher.java

 1/*
 2 * SearchMatcher.java - Abstract string matcher interface
 3 * Copyright (C) 1999, 2001 Slava Pestov
 4 *
 5 * This program is free software; you can redistribute it and/or
 6 * modify it under the terms of the GNU General Public License
 7 * as published by the Free Software Foundation; either version 2
 8 * of the License, or any later version.
 9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 */
19
20package org.gjt.sp.jedit.search;
21
22import gnu.regexp.CharIndexed;
23import javax.swing.text.Segment;
24
25/**
26 * An abstract interface for matching strings.
27 * @author Slava Pestov
28 * @version $Id: SearchMatcher.java 3933 2001-12-03 10:52:27Z spestov $
29 */
30public interface SearchMatcher
31{
32	/**
33	 * Returns the offset of the first match of the specified text
34	 * within this matcher.
35	 * @param text The text to search in
36	 * @param start True if the start of the segment is the beginning of the
37	 * buffer
38	 * @param end True if the end of the segment is the end of the buffer
39	 * @return an array where the first element is the start offset
40	 * of the match, and the second element is the end offset of
41	 * the match
42	 * @since jEdit 4.0pre3
43	 */
44	int[] nextMatch(CharIndexed text, boolean start, boolean end);
45
46	/**
47	 * Returns the specified text, with any substitution specified
48	 * within this matcher performed.
49	 * @param text The text
50	 * @return The changed string
51	 */
52	String substitute(String text) throws Exception;
53}