org.netbeans.api.search

Class SearchScopeOptions

java.lang.Object

org.netbeans.api.search.SearchScopeOptions

public class SearchScopeOptions
extends Object

This class holds user options and custom filters. It is used to specify which files should be iterated by SearchInfo.

It can be initialized with values specified in UI component ScopeOptionsController

Method Summary

Modifier and Type	Method and Description
void	addFilter(SearchFilterDefinition filter) Add a file object filter.
static SearchScopeOptions	create() Create instance initialized with default options.
static SearchScopeOptions	create(String pattern, boolean regexp)
static SearchScopeOptions	create(String pattern, boolean regexp, boolean searchInArchives, boolean searchInGenerated, List<SearchFilterDefinition> filters)
List<SearchFilterDefinition>	getFilters() Get list of custom filters.
String	getPattern()
boolean	isRegexp()
boolean	isSearchInArchives()
boolean	isSearchInGenerated()
void	setPattern(String pattern) Set file name pattern.
void	setRegexp(boolean regexp) Set whether the pattern should be handled as regular expression.
void	setSearchInArchives(boolean searchInArchives) Set searching in archives.
void	setSearchInGenerated(boolean searchInGenerated) Set searching in generated sources.

Methods inherited from class java.lang.Object

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

Method Detail

addFilter

public void addFilter(@NonNull
                      SearchFilterDefinition filter)

Add a file object filter.

getFilters

@NonNull
public List<SearchFilterDefinition> getFilters()

Get list of custom filters.

isSearchInArchives

public boolean isSearchInArchives()

Returns:

true if and only if searching in archives is enabled.

setSearchInArchives

public void setSearchInArchives(boolean searchInArchives)

Set searching in archives.

isSearchInGenerated

public boolean isSearchInGenerated()

Returns:

true if and only if searching in generated sources in enabled.

setSearchInGenerated

public void setSearchInGenerated(boolean searchInGenerated)

Set searching in generated sources.

getPattern

public String getPattern()

Returns:

File name pattern. If not specified, returns empty string, never null.

setPattern

public void setPattern(@NullAllowed
                       String pattern)

Set file name pattern.

isRegexp

public boolean isRegexp()

Returns:

True if and only if the pattern should be handled as regular expression.

setRegexp

public void setRegexp(boolean regexp)

Set whether the pattern should be handled as regular expression.

create

@NonNull
public static SearchScopeOptions create()

Create instance initialized with default options.

create

@NonNull
public static SearchScopeOptions create(@NullAllowed
                                                 String pattern,
                                                 boolean regexp)

Parameters:

pattern - File name pattern.

regexp - Regular expression mode.

Returns:

Instance initialized with passed file-name related options.

create

@NonNull
public static SearchScopeOptions create(@NullAllowed
                                                 String pattern,
                                                 boolean regexp,
                                                 boolean searchInArchives,
                                                 boolean searchInGenerated,
                                                 @NullAllowed
                                                 List<SearchFilterDefinition> filters)

Parameters:

pattern - File name pattern.

regexp - File name pattern specified as regular expression.

searchInArchives - Enable searching in archives.

searchInGenerated - Enable searching in generated sources.

filters - List of file object filters. Can be null.

Returns:

Instance initialized with passed options;