Constructor Detail

• SearchFilter

  public SearchFilter​()

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

  Returns:

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

  Throws:

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

• searchFile

  public abstract boolean searchFile​(@NonNull
                                     java.net.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:

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

  Since:

  org.netbeans.api.search/1.4

• traverseFolder

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

  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:

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

• traverseFolder

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

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

  Since:

  org.netbeans.api.search/1.4