org.netbeans.api.search

Class SearchRoot

java.lang.Object

org.netbeans.api.search.SearchRoot

public final class SearchRoot
extends Object

Search root is a pair containing a folder (or file) and a set of search filters.

Constructor Summary

Constructors

Constructor and Description
SearchRoot(FileObject rootFile, List<SearchFilter> filters) Create a new search root, defined by a folder and a set of filters.
SearchRoot(URI rootUri, List<SearchFilter> filters) Create a new search root, defined by a folder and a set of filters.

Method Summary

Modifier and Type	Method and Description
FileObject	getFileObject() Get the file object.
List<SearchFilter>	getFilters() Get list of filters.
URI	getUri() Get URI of the search root.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRoot

public SearchRoot(@NonNull
                  FileObject rootFile,
                  @NullAllowed
                  List<SearchFilter> filters)

Create a new search root, defined by a folder and a set of filters.

Parameters:

rootFile - Root file, cannot be null.

filters - List of default filters, can be null.

SearchRoot

public SearchRoot(@NonNull
                  URI rootUri,
                  @NullAllowed
                  List<SearchFilter> filters)

Create a new search root, defined by a folder and a set of filters.

Parameters:

rootUri - Root URI, cannot be null.

filters - List of default filters, can be null.

Since:

org.netbeans.api.search/1.4

Method Detail

getFilters

@NonNull
public List<SearchFilter> getFilters()

Get list of filters.

Returns:

List of default filters. Can be empty list, but never null.

getFileObject

@NonNull
public FileObject getFileObject()

Get the file object.

Returns:

Root file (regular file or folder). Never null.

getUri

@NonNull
public URI getUri()

Get URI of the search root.

Since:

org.netbeans.api.search/1.4