org.netbeans.api.search.provider

Class SearchInfoUtils

java.lang.Object

org.netbeans.api.search.provider.SearchInfoUtils

public final class SearchInfoUtils
extends Object

Class containing methods for getting SearchInfo instances for nodes and files.

Field Summary

Fields

Modifier and Type	Field and Description
static List<SearchFilter>	DEFAULT_FILTERS Immutable list of default search filters.
static SearchFilter	SHARABILITY_FILTER Filter for skipping unsharable files.
static SearchFilter	VISIBILITY_FILTER Filter for skipping invisible files.

Constructor Summary

Constructors

Constructor and Description
SearchInfoUtils()

Method Summary

Modifier and Type	Method and Description
static SearchInfo	createCompoundSearchInfo(SearchInfo... delegates) Creates a SearchInfo compound of the given delegates.
static SearchInfo	createEmptySearchInfo() Create a SearchInfo instance that is always unsearchable.
static SearchInfo	createForDefinition(SearchInfoDefinition definition) Create a new SearchInfo for a SearchInfoDefinition instance.
static SearchInfo	createSearchInfoForRoot(FileObject root) Create a search info for a FileObject.
static SearchInfo	createSearchInfoForRoots(FileObject[] roots) Create a search info for an array of FileObjects.
static SearchInfo	createSearchInfoForRoots(FileObject[] roots, boolean useDefaultFilters, SearchFilterDefinition... extraFilters) Create a search info for an array of FileObjects.
static SearchInfo	findDefinedSearchInfo(Node node) Get a search info for a node, if it was explicitly defined in node's lookup, or in lookup of a ancestor node.
static SearchInfo	getSearchInfoForNode(Node node) Gets a search info for node.

Methods inherited from class java.lang.Object

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

Field Detail

VISIBILITY_FILTER

public static final SearchFilter VISIBILITY_FILTER

Filter for skipping invisible files. One of default filters.

SHARABILITY_FILTER

public static final SearchFilter SHARABILITY_FILTER

Filter for skipping unsharable files. One of default filters.

DEFAULT_FILTERS

public static final List<SearchFilter> DEFAULT_FILTERS

Immutable list of default search filters.

Constructor Detail

SearchInfoUtils

public SearchInfoUtils()

Method Detail

getSearchInfoForNode

@CheckForNull
public static SearchInfo getSearchInfoForNode(@NonNull
                                                            Node node)

Gets a search info for node.

Algorithm for getting search info:

1. Look for SearchInfoDefinition in lookup of the node. If found, create and return search info for this definition.
2. Look for SubTreeSearchOptions in lookups of this node and its ancestors. If found, check if the node has a FileObject (possibly as primary file of a DataObject) in its lookup, and, if so, create search info for recursive searching in the file object, using filters defined in found SubTreeSearchOptions.
3. Check whether the node has a FileObject (possibly as primary file of a DataObject) in is lookup. If so, create default search info for that file object. Default means that the file object will be searched recursively, using default filters.
4. Return null.

Returns:

Search info for a node. If no search info was defined and it cannot be created for this node, null is returned.

See Also:

FileObject, DataObject, SearchInfoDefinition, SubTreeSearchOptions, SearchInfoUtils.findDefinedSearchInfo(org.openide.nodes.Node)

findDefinedSearchInfo

@CheckForNull
public static SearchInfo findDefinedSearchInfo(@NonNull
                                                             Node node)

Get a search info for a node, if it was explicitly defined in node's lookup, or in lookup of a ancestor node. Default search info is not created.

Returns:

Defined SearchInfo, or null if not available.

See Also:

SearchInfoUtils.getSearchInfoForNode(org.openide.nodes.Node)

createForDefinition

@NonNull
public static SearchInfo createForDefinition(@NonNull
                                                      SearchInfoDefinition definition)

Create a new SearchInfo for a SearchInfoDefinition instance.

Parameters:

definition - Search info definition.

createCompoundSearchInfo

@NonNull
public static SearchInfo createCompoundSearchInfo(@NonNull
                                                           SearchInfo... delegates)

Creates a SearchInfo compound of the given delegates. It combines the delegates such that:

• its method SearchInfo.canSearch() returns true if and only if at least one of the delegate's canSearch() returns true
• its method SearchInfo.createFilesToSearchIterator(SearchScopeOptions, SearchListener, AtomicBoolean) chains iterators of the delegates, skipping those delegates whose canSearch() method returns false

Parameters:

delegates - delegates the compound SearchInfo should delegate to

Returns:

created compound SearchInfo

Throws:

NullPointerException - if the argument is null

createEmptySearchInfo

@NonNull
public static SearchInfo createEmptySearchInfo()

Create a SearchInfo instance that is always unsearchable.

Returns:

Search info whose SearchInfo.canSearch() returns always null.

createSearchInfoForRoot

@NonNull
public static SearchInfo createSearchInfoForRoot(@NonNull
                                                          FileObject root)

Create a search info for a FileObject. Default filters will be used. If root is a folder, it will be searched recursively.

Parameters:

root - File of folder where recursive searching should start.

createSearchInfoForRoots

@NonNull
public static SearchInfo createSearchInfoForRoots(@NonNull
                                                           FileObject[] roots)

Create a search info for an array of FileObjects. Default filters will be used.

Using this method is preferable to creating several SearchInfo instances for individual roots using SearchInfoUtils.createSearchInfoForRoot(FileObject) and then combining them with SearchInfoUtils.createCompoundSearchInfo(SearchInfo[]).

Parameters:

roots - Array of root files or folders.

createSearchInfoForRoots

@NonNull
public static SearchInfo createSearchInfoForRoots(@NonNull
                                                           FileObject[] roots,
                                                           boolean useDefaultFilters,
                                                           @NonNull
                                                           SearchFilterDefinition... extraFilters)

Create a search info for an array of FileObjects.

Parameters:

useDefaultFilters - True if default filters (visibility filter and sharability filter) should be used, false otherwise.

extraFilters - Array of extra custom filters.