public abstract class SearchFilterDefinition extends Object
Modifier and Type | Class | Description |
---|---|---|
static class |
SearchFilterDefinition.FolderResult |
Result of filtering a folder.
|
Constructor | Description |
---|---|
SearchFilterDefinition() |
Modifier and Type | Method | Description |
---|---|---|
boolean |
searchFile(URI uri) |
Answers a question whether a file with given URI should be searched.
|
abstract boolean |
searchFile(org.openide.filesystems.FileObject file) |
Answers a question whether a given file should be searched.
|
SearchFilterDefinition.FolderResult |
traverseFolder(URI uri) |
Answers a questions whether a folder with given URI should be traversed
(its contents searched).
|
abstract SearchFilterDefinition.FolderResult |
traverseFolder(org.openide.filesystems.FileObject folder) |
Answers a questions whether a given folder should be traversed (its
contents searched).
|
public abstract boolean searchFile(@NonNull org.openide.filesystems.FileObject file) throws IllegalArgumentException
true
if the given file should be searched;
false
if notIllegalArgumentException
- if the passed
FileObject
is a folder@NonNull public abstract SearchFilterDefinition.FolderResult traverseFolder(@NonNull org.openide.filesystems.FileObject folder) throws IllegalArgumentException
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)IllegalArgumentException
- if the passed
FileObject
is not a folderpublic boolean searchFile(@NonNull URI uri)
FileObject
instance for each
URI and passes it to searchFile(FileObject)
. Override to improve
performance.true
if the given file should be searched;
false
if notIllegalArgumentException
- if the passed
FileObject
is a folder@NonNull public SearchFilterDefinition.FolderResult traverseFolder(@NonNull URI uri) throws IllegalArgumentException
FileObject
instance for each
URI and passes it to traverseFolder(FileObject)
. Override to
improve performance.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)IllegalArgumentException
- if the passed
FileObject
is not a folderBuilt on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.