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