org.netbeans.spi.search

Class SearchFilterDefinition

java.lang.Object

org.netbeans.spi.search.SearchFilterDefinition

public abstract class SearchFilterDefinition
extends Object

Implementations of this class define which files and folders should be searched and which should be skipped during search over a directory structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchFilterDefinition.FolderResult Result of filtering a folder.

Constructor Summary

Constructors

Constructor and Description
SearchFilterDefinition()

Method Summary

Modifier and Type	Method and Description
abstract boolean	searchFile(FileObject file) Answers a question whether a given file should be searched.
boolean	searchFile(URI uri) Answers a question whether a file with given URI should be searched.
abstract SearchFilterDefinition.FolderResult	traverseFolder(FileObject folder) Answers a questions whether a given folder should be traversed (its contents searched).
SearchFilterDefinition.FolderResult	traverseFolder(URI uri) Answers a questions whether a folder with given URI should be traversed (its contents searched).

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilterDefinition

public SearchFilterDefinition()

Method Detail

searchFile

public abstract boolean searchFile(@NonNull
                                   FileObject file)
                            throws IllegalArgumentException

Answers a question whether a given file should be searched. The file must be a plain file (not folder). Every file matching SearchScopeOptions criteria will be passed to this method. Please make sure that the computation is as fast as possible.

Returns:

true if the given file should be searched; false if not

Throws:

IllegalArgumentException - if the passed FileObject is a folder

traverseFolder

@NonNull
public abstract SearchFilterDefinition.FolderResult traverseFolder(@NonNull
                                                                            FileObject folder)
                                                                     throws IllegalArgumentException

Answers a questions whether a given folder should be traversed (its contents searched). The passed argument must be a folder. Every traversed folder will be passed to this method. Please make sure the computation is as fast as possible!

Returns:

One of constants of SearchFilterDefinition.FolderResult. If TRAVERSE_ALL_SUBFOLDERS is returned, this filter will not be applied on the folder's children (both direct and indirect, both files and folders)

Throws:

IllegalArgumentException - if the passed FileObject is not a folder

searchFile

public boolean searchFile(@NonNull
                          URI uri)

Answers a question whether a file with given URI should be searched. The file must be URI of a plain file (not folder). The default implementation creates a FileObject instance for each URI and passes it to SearchFilterDefinition.searchFile(FileObject). Override to improve performance.

Returns:

true if the given file should be searched; false if not

Throws:

IllegalArgumentException - if the passed FileObject is a folder

Since:

org.netbeans.api.search/1.4

traverseFolder

@NonNull
public SearchFilterDefinition.FolderResult traverseFolder(@NonNull
                                                                   URI uri)
                                                            throws IllegalArgumentException

Answers a questions whether a folder with given URI should be traversed (its contents searched). The passed argument must be URI of a folder. The default implementation creates a FileObject instance for each URI and passes it to SearchFilterDefinition.traverseFolder(FileObject). Override to improve performance.

Returns:

One of constants of SearchFilterDefinition.FolderResult. If TRAVERSE_ALL_SUBFOLDERS is returned, this filter will not be applied on the folder's children (both direct and indirect, both files and folders)

Throws:

IllegalArgumentException - if the passed FileObject is not a folder

Since:

org.netbeans.api.search/1.4