org.netbeans.api.search.provider

Class SearchListener

java.lang.Object

org.netbeans.api.search.provider.SearchListener

public abstract class SearchListener
extends Object

Listener for various events during searching.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchListener() Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
void	directoryEntered(String path) Called when a directory was visited.
void	fileContentMatchingError(String fileName, Throwable throwable) Called when an exception occurs during file content checking.
void	fileContentMatchingProgress(String fileName, long fileOffset) Called when matching in file progresses.
void	fileContentMatchingStarted(String fileName) Called when matching in file content is to start.
void	fileSkipped(FileObject fileObject, SearchFilterDefinition filter, String message) Called when a file is skipped - filtered out by a filter.
void	fileSkipped(URI uri, SearchFilterDefinition filter, String message) Called when a file is skipped - filtered out by a filter.
void	generalError(Throwable t) Called when a general error occurs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchListener

protected SearchListener()

Constructor for subclasses.

Method Detail

fileSkipped

public void fileSkipped(@NonNull
                        FileObject fileObject,
                        @NullAllowed
                        SearchFilterDefinition filter,
                        @NullAllowed
                        String message)

Called when a file is skipped - filtered out by a filter.

Parameters:

fileObject - the skipped file object.

filter - filter that filtered out the file (can be null).

message - message describing reasons for skipping (can be null).

fileSkipped

public void fileSkipped(@NonNull
                        URI uri,
                        @NullAllowed
                        SearchFilterDefinition filter,
                        @NullAllowed
                        String message)

Called when a file is skipped - filtered out by a filter.

Parameters:

uri - the skipped URI.

filter - filter that filtered out the file (can be null).

message - message describing reasons for skipping (can be null).

Since:

org.netbeans.api.search/1.4

directoryEntered

public void directoryEntered(@NonNull
                             String path)

Called when a directory was visited.

Parameters:

path - Path of the visited directory.

fileContentMatchingStarted

public void fileContentMatchingStarted(@NonNull
                                       String fileName)

Called when matching in file content is to start.

Parameters:

fileName - Name of file.

fileContentMatchingProgress

public void fileContentMatchingProgress(@NonNull
                                        String fileName,
                                        long fileOffset)

Called when matching in file progresses. If matching in a file reaches some interresting point (e.g. next matched line), the matching algorithm can call this method. The implementators will probably update progress bar or do something similar.

Parameters:

fileName - Name of file whose content is being read.

fileOffset - Offset in file that has been processed.

fileContentMatchingError

public void fileContentMatchingError(@NonNull
                                     String fileName,
                                     @NonNull
                                     Throwable throwable)

Called when an exception occurs during file content checking.

Parameters:

fileName - File that caused the error.

throwable - Error description.

generalError

public void generalError(@NonNull
                         Throwable t)

Called when a general error occurs.

Parameters:

t - Error description.