org.eclipse.cdt.internal.core.index.provider

Class IndexProviderManager

java.lang.Object

org.eclipse.cdt.internal.core.index.provider.IndexProviderManager

public final class IndexProviderManager
extends java.lang.Object

The IndexProviderManager is responsible for maintaining the set of index fragments contributed via the CIndex extension point.

For bug 196338, the role of this class was extended. It now has responsibility to look at the pool of fragments available depending on their IDs, and select the most appropriate. The following rules are applied:

• If a fragment is not compatible, don't use it.
• If multiple fragments are compatible, pick the latest.

A warning is logged if a fragment is contributed which is incompatible, and for which there is no compatible equivalent. It is an internal class, and is public only for testing purposes.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
IndexProviderManager()

Method Summary

Modifier and Type	Method and Description
void	addIndexProvider(IIndexProvider provider) Adds a PDOM-based index fragment provider.
void	elementChanged(ElementChangedEvent event)
int	getOption(IConfigurationElement elem, java.lang.String attributeName, int option)
IIndexFragment[]	getProvidedIndexFragments(ICConfigurationDescription config, int usage) Get the array of IIndexFragment objects provided by all of the registered IIndexProvider objects for the specified project, and for the current state of the project.
void	removeIndexProvider(IIndexProvider provider) Removes the specified provider by object identity.
void	reset() Note: This method should not be called by clients for purposes other than testing
void	reset(VersionRange pdomVersionRange) Note: This method should not be called by clients for purposes other than testing
void	startup()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexProviderManager

public IndexProviderManager()

Method Detail

reset

public void reset()

Note: This method should not be called by clients for purposes other than testing

reset

public void reset(VersionRange pdomVersionRange)

Note: This method should not be called by clients for purposes other than testing

Parameters:

pdomVersionRange -

startup

public void startup()

getOption

public int getOption(IConfigurationElement elem,
                     java.lang.String attributeName,
                     int option)

getProvidedIndexFragments

public IIndexFragment[] getProvidedIndexFragments(ICConfigurationDescription config,
                                                  int usage)
                                           throws CoreException

Get the array of IIndexFragment objects provided by all of the registered IIndexProvider objects for the specified project, and for the current state of the project. Order in the array is not significant.

Parameters:

config -

Returns:

the array of IIndexFragment objects for the current state

Throws:

CoreException

addIndexProvider

public void addIndexProvider(IIndexProvider provider)

Adds a PDOM-based index fragment provider. Note: This method should not be called for purposes other than testing

Parameters:

provider -

removeIndexProvider

public void removeIndexProvider(IIndexProvider provider)

Removes the specified provider by object identity. Only a PDOM-based provider can be removed using this method. Note: This method should not be called for purposes other than testing

Parameters:

provider -

elementChanged

public void elementChanged(ElementChangedEvent event)