com.intellij.psi.search
Interface IndexPatternProvider

public interface IndexPatternProvider

Provider of regular expression patterns the occurrences of which in the comments of source code files are indexed by IDEA. Implementations of this interface need to be registered as extensions for the indexPatternProvider extension point.

Since:

5.1

See Also:

IndexPatternSearch

Field Summary

static java.lang.String

PROP_INDEX_PATTERNS The property the change of which should be reported to the property change listener when the list of index patterns is changed.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a listener which is notified when the set of index patterns provided by this provider changes.
void	dispatchPendingEvent(java.beans.PropertyChangeListener listener)
IndexPattern[]	getIndexPatterns() Returns the list of index patterns the occurrences of which should be indexed by IDEA.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a listener which is notified when the set of index patterns provided by this provider changes.

Field Detail

PROP_INDEX_PATTERNS

@NonNls
static final java.lang.String PROP_INDEX_PATTERNS

The property the change of which should be reported to the property change listener when the list of index patterns is changed.

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener), Constant Field Values

Method Detail

getIndexPatterns

@NotNull
IndexPattern[] getIndexPatterns()

Returns the list of index patterns the occurrences of which should be indexed by IDEA.

Returns:

the array of index patterns

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a listener which is notified when the set of index patterns provided by this provider changes. The property the change of which should be reported is PROP_INDEX_PATTERNS.

Parameters:

listener - the listener to add.

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a listener which is notified when the set of index patterns provided by this provider changes.

Parameters:

listener - the listener to remove.

dispatchPendingEvent

void dispatchPendingEvent(java.beans.PropertyChangeListener listener)