Package adams.core.io.filesearch

Interface FileSearchHandler

All Superinterfaces:

Stoppable, StoppableWithFeedback

All Known Subinterfaces:

RegExpFileSearchHandler

All Known Implementing Classes:

AbstractFileSearchHandler, AbstractFileSearchHandlerWithEncoding, AbstractMetaFileSearchHandler, AbstractMetaFileSearchHandlerWithEncoding, Bzip2FileSearchHandler, GzipFileSearchHandler, LzfFileSearchHandler, LzmaFileSearchHandler, RarFileSearchHandler, TextFileSearchHandler, XzFileSearchHandler, ZipFileSearchHandler, ZstdFileSearchHandler

public interface FileSearchHandler
extends StoppableWithFeedback

Interface for classes that search files.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
boolean	handles(String file)	Checks whether the handler can manage this file.
boolean	searchFile(String file, String searchText, boolean caseSensitive, ExceptionHandler handler)	Searches the specified file.

Methods inherited from interface adams.core.Stoppable

stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback

isStopped

Method Detail

handles

boolean handles(String file)

Checks whether the handler can manage this file.

Parameters:

file - the file to check

Returns:

true if handler can search this type of file

searchFile

boolean searchFile(String file,
                   String searchText,
                   boolean caseSensitive,
                   ExceptionHandler handler)

Searches the specified file.

Parameters:

file - the file to search

searchText - the search text

handler - for handling exceptions, can be null

Returns:

true if the search text was found