/jEdit/tags/jedit-4-2-pre4/org/gjt/sp/jedit/search/SearchFileSet.java

 1/*
 2 * SearchFileSet.java - Abstract file 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 org.gjt.sp.jedit.*;
23
24/**
25 * An abstract interface representing a set of files.
26 * @author Slava Pestov
27 * @version $Id: SearchFileSet.java 4455 2003-01-31 04:49:31Z spestov $
28 */
29public interface SearchFileSet
30{
31	/**
32	 * Returns the first file to search.
33	 * @param view The view performing the search
34	 */
35	String getFirstFile(View view);
36
37	/**
38	 * Returns the next file to search.
39	 * @param view The view performing the search
40	 * @param buffer The last file searched
41	 */
42	String getNextFile(View view, String path);
43
44	/**
45	 * Returns all path names in this file set.
46	 * @param view The view performing the search
47	 */
48	String[] getFiles(View view);
49
50	/**
51	 * Returns the number of files in this file set.
52	 */
53	int getFileCount(View view);
54
55	/**
56	 * Returns the BeanShell code that will recreate this file set.
57	 */
58	String getCode();
59}