org.netbeans.api.search.provider

Class SearchInfo

java.lang.Object

org.netbeans.api.search.provider.SearchInfo

public abstract class SearchInfo
extends Object

Info about searching under a node or a set of nodes.

Constructor Summary

Constructors

Constructor and Description
SearchInfo()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canSearch() Checks that searching is possible.
protected abstract Iterator<FileObject>	createFilesToSearchIterator(SearchScopeOptions options, SearchListener listener, AtomicBoolean terminated) Create Iterator that iterates over all files in the search scope that comply with search options and search filters.
protected abstract Iterator<URI>	createUrisToSearchIterator(SearchScopeOptions options, SearchListener listener, AtomicBoolean terminated) Create Iterator that iterates over all URIs in the search scope that comply with search options and search filters.
Iterable<FileObject>	getFilesToSearch(SearchScopeOptions options, SearchListener listener, AtomicBoolean terminated) Get Iterable that iterates over all files in the search scope that comply with search options and search filters.
abstract List<SearchRoot>	getSearchRoots() Get search roots.
Iterable<URI>	getUrisToSearch(SearchScopeOptions options, SearchListener listener, AtomicBoolean terminated) Get Iterable that iterates over all URIs in the search scope that comply with search options and search filters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 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 Iterator<FileObject> createFilesToSearchIterator(@NonNull
                                                                             SearchScopeOptions options,
                                                                             @NonNull
                                                                             SearchListener listener,
                                                                             @NonNull
                                                                             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 Iterator<URI> createUrisToSearchIterator(@NonNull
                                                                     SearchScopeOptions options,
                                                                     @NonNull
                                                                     SearchListener listener,
                                                                     @NonNull
                                                                     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 Iterable<FileObject> getFilesToSearch(@NonNull
                                                            SearchScopeOptions options,
                                                            @NonNull
                                                            SearchListener listener,
                                                            @NonNull
                                                            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 Iterable<URI> getUrisToSearch(@NonNull
                                                    SearchScopeOptions options,
                                                    @NonNull
                                                    SearchListener listener,
                                                    @NonNull
                                                    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