Constructor Detail

• SearchFilterDefinition

  public SearchFilterDefinition​()

Method Detail

• searchFile

  public abstract boolean searchFile​(@NonNull
                                     org.openide.filesystems.FileObject file)
                              throws java.lang.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:

  java.lang.IllegalArgumentException - if the passed FileObject is a folder

• traverseFolder

  @NonNull
  public abstract SearchFilterDefinition.FolderResult traverseFolder​(@NonNull
                                                                     org.openide.filesystems.FileObject folder)
                                                              throws java.lang.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:

  java.lang.IllegalArgumentException - if the passed FileObject is not a folder

• searchFile

  public boolean searchFile​(@NonNull
                            java.net.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 searchFile(FileObject). Override to improve performance.

  Returns:

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

  Throws:

  java.lang.IllegalArgumentException - if the passed FileObject is a folder

  Since:

  org.netbeans.api.search/1.4

• traverseFolder

  @NonNull
  public SearchFilterDefinition.FolderResult traverseFolder​(@NonNull
                                                            java.net.URI uri)
                                                     throws java.lang.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 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:

  java.lang.IllegalArgumentException - if the passed FileObject is not a folder

  Since:

  org.netbeans.api.search/1.4