org.netbeans.api.search.provider

Class SearchFilter

java.lang.Object

org.netbeans.api.search.provider.SearchFilter

public abstract class SearchFilter
extends Object

Implementation of search filter that is associated with a search root. All search providers should respect search filters. It is only relevant if custom algorithm for for traversing is used instead of standard iterating.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchFilter()

Method Summary

Modifier and Type	Method and Description
abstract boolean	searchFile(FileObject file) Answers a question whether a given file should be searched.
abstract boolean	searchFile(URI fileUri) Answers a question whether a given URI should be searched.
abstract SearchFilter.FolderResult	traverseFolder(FileObject folder) Answers a questions whether a given folder should be traversed (its contents searched).
abstract SearchFilter.FolderResult	traverseFolder(URI folderUri) Answers a questions whether a 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

SearchFilter

public SearchFilter()

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).

Returns:

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

Throws:

IllegalArgumentException - if the passed FileObject is a folder

searchFile

public abstract boolean searchFile(@NonNull
                                   URI fileUri)

Answers a question whether a given URI should be searched. The URI must stand for a plain file (not folder).

Returns:

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

Throws:

IllegalArgumentException - if the passed URI is a folder

Since:

org.netbeans.api.search/1.4

traverseFolder

@NonNull
public abstract SearchFilter.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.

Returns:

One of constants of SearchFilter.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

traverseFolder

@NonNull
public abstract SearchFilter.FolderResult traverseFolder(@NonNull
                                                                  URI folderUri)
                                                           throws IllegalArgumentException

Answers a questions whether a given URI should be traversed (its contents searched). The passed URI must stand for a folder.

Returns:

One of constants of SearchFilter.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 URI is not a folder

Since:

org.netbeans.api.search/1.4