Constructor Detail

• SearchInfo

  public SearchInfo​()

Method Detail

• canSearch

  public abstract boolean canSearch​()

  Checks that searching is possible.

  Returns:

  False is searching is not possible (it is not supported or it is sure that there are no files to search), true if there is chance that some files can be found.

• getSearchRoots

  @NonNull
  public abstract java.util.List<SearchRoot> getSearchRoots​()

  Get search roots. This information can be used for computing relative paths, or in custom algorithms for file traversing.

  Returns:

  List of search roots associated with this search info.

• createFilesToSearchIterator

  @NonNull
  protected abstract java.util.Iterator<org.openide.filesystems.FileObject> createFilesToSearchIterator​(@NonNull
                                                                                                        SearchScopeOptions options,
                                                                                                        @NonNull
                                                                                                        SearchListener listener,
                                                                                                        @NonNull
                                                                                                        java.util.concurrent.atomic.AtomicBoolean terminated)

  Create Iterator that iterates over all files in the search scope that comply with search options and search filters.

  Parameters:

  options - Custom options. This object encapsulates custom search filters, file name pattern and general search settings.

  listener - Listener that is notified when some important event occurs during searching. Listener passed to SearchComposition should be used here.

  terminated - Object that can be asked by the iterator whether the search has been terminated.

  Returns:

  Iterator over all files that comply with specified options (in the scope of this search info).

• createUrisToSearchIterator

  @NonNull
  protected abstract java.util.Iterator<java.net.URI> createUrisToSearchIterator​(@NonNull
                                                                                 SearchScopeOptions options,
                                                                                 @NonNull
                                                                                 SearchListener listener,
                                                                                 @NonNull
                                                                                 java.util.concurrent.atomic.AtomicBoolean terminated)

  Create Iterator that iterates over all URIs in the search scope that comply with search options and search filters.

  Parameters:

  options - Custom options. This object encapsulates custom search filters, file name pattern and general search settings.

  listener - Listener that is notified when some important event occurs during searching. Listener passed to SearchComposition should be used here.

  terminated - Object that can be asked by the iterator whether the search has been terminated.

  Returns:

  Iterator over all URIs that comply with specified options (in the scope of this search info).

  Since:

  org.netbeans.api.search/1.4

• getFilesToSearch

  @NonNull
  public final java.lang.Iterable<org.openide.filesystems.FileObject> getFilesToSearch​(@NonNull
                                                                                       SearchScopeOptions options,
                                                                                       @NonNull
                                                                                       SearchListener listener,
                                                                                       @NonNull
                                                                                       java.util.concurrent.atomic.AtomicBoolean terminated)

  Get Iterable that iterates over all files in the search scope that comply with search options and search filters.

  Parameters:

  options - Custom options. This object encapsulates custom search filters, file name pattern and general search settings.

  listener - Listener that is notified when some important event occurs during searching. Listener passed to SearchComposition should be used here.

  terminated - Object that can be asked by the iterator whether the search has been terminated.

  This method can be used in for-each loops:

   
   for (FileObject fo: searchInfo.getFilesToSearch(opts,listnr,term) {
     ResultType result = somehowCheckFileContentMatches(fo);
     if (result != null) {
       searchResultsDisplayer.addMatchingObject(result);
     }
   }
   

• getUrisToSearch

  @NonNull
  public final java.lang.Iterable<java.net.URI> getUrisToSearch​(@NonNull
                                                                SearchScopeOptions options,
                                                                @NonNull
                                                                SearchListener listener,
                                                                @NonNull
                                                                java.util.concurrent.atomic.AtomicBoolean terminated)

  Get Iterable that iterates over all URIs in the search scope that comply with search options and search filters.

  Parameters:

  options - Custom options. This object encapsulates custom search filters, file name pattern and general search settings.

  listener - Listener that is notified when some important event occurs during searching. Listener passed to SearchComposition should be used here.

  terminated - Object that can be asked by the iterator whether the search has been terminated.

  This method can be used in for-each loops:

   
   for (URI uri: searchInfo.getUrisToSearch(opts,listnr,term) {
     ResultType result = somehowCheckFileContentMatches(fo);
     if (result != null) {
       searchResultsDisplayer.addMatchingObject(result);
     }
   }
   

  Since:

  org.netbeans.api.search/1.4