org.netbeans.modules.parsing.spi.indexing

Interface IndexabilityQueryImplementation

public interface IndexabilityQueryImplementation

Determine whether files should be skipped for indexing.

Global lookup is used to find all instances of IndexabilityQueryImplementation.

Threading note: implementors should avoid acquiring locks that might be held by other threads. Generally treat this interface similarly to SPIs in org.openide.filesystems with respect to threading semantics.

Since:

org.netbeans.modules.parsing.indexing 9.24.0

See Also:

IndexabilityQuery

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IndexabilityQueryImplementation.IndexabilityQueryContext

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l) Add a listener to changes.
String	getName()
String	getStateIdentifier() It is not the intention of this to represent the configuration, that should be stored in the configuration, but should make it possible to identify changes to the configuration.
int	getVersion()
default boolean	preventIndexing(IndexabilityQueryImplementation.IndexabilityQueryContext iqp) Determine if the supplied indexable should be indexed using the given indexer (identified either by the name of the indexer or its factory class).
void	removeChangeListener(ChangeListener l) Stop listening to changes.

Method Detail

getName

String getName()

Returns:

name of the IndexabilityQueryImplementation. The allowed characters are from the range: [A-Za-z0-9$_.+/].

getVersion

int getVersion()

Returns:

version of the IndexabilityQueryImplementation, must be incremented if changes in the implementation would affect indexing results

getStateIdentifier

String getStateIdentifier()

It is not the intention of this to represent the configuration, that should be stored in the configuration, but should make it possible to identify changes to the configuration. A valid identifier for example would be a checksum over the configuration. It must be ensured, that for a given configuration the same stateIdentifier is returned. It must not change between NetBeans restarts - else a full reindex will be done.

Returns:

an identifier, that identifies the state of the indexability query. The allowed characters are from the range: [A-Za-z0-9$_.+/].

preventIndexing

default boolean preventIndexing(IndexabilityQueryImplementation.IndexabilityQueryContext iqp)

Determine if the supplied indexable should be indexed using the given indexer (identified either by the name of the indexer or its factory class).

Parameters:

iqp - information about the indexable and circumstances of the indexing action

Returns:

addChangeListener

void addChangeListener(ChangeListener l)

Add a listener to changes.

Parameters:

l - a listener to add

removeChangeListener

void removeChangeListener(ChangeListener l)

Stop listening to changes.

Parameters:

l - a listener to remove