Package org.aspectj.org.eclipse.jdt.internal.core.search.indexing

Class IndexManager

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.search.processing.JobManager

org.aspectj.org.eclipse.jdt.internal.core.search.indexing.IndexManager

All Implemented Interfaces:

IIndexConstants

public class IndexManager
extends JobManager
implements IIndexConstants

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEBUG
static final String	INDEX_MANAGER_NOTIFY_IDLE_WAIT_PROPERTY
SimpleLookupTable	indexLocations	synchronized by IndexManager.this key = containerPath, value = indexLocation path indexLocation path is created by appending an index file name to the getJavaPluginWorkingLocation() path
static final String	MANAGE_PRODUCT_INDEXES_PROPERTY
static final Integer	REBUILDING_STATE
static final Integer	REUSE_STATE
static final Integer	SAVED_STATE
static final Integer	UNKNOWN_STATE
static final Integer	UPDATING_STATE

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.search.processing.JobManager

VERBOSE

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.core.search.indexing.IIndexConstants

AND_PATTERN, ANNOT_REF_PATTERN, ANNOTATION_REF, ANNOTATION_TYPE_SUFFIX, CLASS_AND_ENUM_SUFFIX, CLASS_AND_INTERFACE_SUFFIX, CLASS_SUFFIX, CONSTRUCTOR_DECL, CONSTRUCTOR_PATTERN, CONSTRUCTOR_REF, COUNTS, DEFAULT_CONSTRUCTOR, ENUM_SUFFIX, FIELD_DECL, FIELD_PATTERN, INTERFACE_AND_ANNOTATION_SUFFIX, INTERFACE_SUFFIX, LOCAL_VAR_PATTERN, META_INDEX_CATEGORIES, META_INDEX_QUALIFIED_SUPER_TYPE_QUALIFIER_REF, META_INDEX_QUALIFIED_TYPE_QUALIFIER_REF, META_INDEX_SIMPLE_SUPER_TYPE_QUALIFIER_REF, META_INDEX_SIMPLE_TYPE_QUALIFIER_REF, METHOD_DECL, METHOD_DECL_PLUS, METHOD_PATTERN, METHOD_REF, MODULE_DECL, MODULE_INFO, MODULE_PATTERN, MODULE_REF, OBJECT, ONE_STAR, ONE_STAR_CHAR, ONE_ZERO, ONE_ZERO_CHAR, OR_PATTERN, PARAMETER_SEPARATOR, PKG_DECL_PATTERN, PKG_REF_PATTERN, REF, SECONDARY_SUFFIX, SEPARATOR, SUPER_REF, SUPER_REF_PATTERN, TYPE_DECL, TYPE_DECL_PATTERN, TYPE_PARAM_PATTERN, TYPE_REF_PATTERN, TYPE_SUFFIX, ZERO_CHAR

Constructor Summary

Constructors

Constructor	Description
IndexManager()

Method Summary

Modifier and Type	Method	Description
void	aboutToUpdateIndex(org.eclipse.core.runtime.IPath containerPath, Integer newIndexState)
void	addBinary(org.eclipse.core.resources.IFile resource, org.eclipse.core.runtime.IPath containerPath)	Trigger addition of a resource to an index Note: the actual operation is performed in background
void	addSource(org.eclipse.core.resources.IFile resource, org.eclipse.core.runtime.IPath containerPath, SourceElementParser parser)	Trigger addition of a resource to an index Note: the actual operation is performed in background
void	cleanUpIndexes()	Removes unused indexes from disk.
IndexLocation	computeIndexLocation(org.eclipse.core.runtime.IPath containerPath)
IndexLocation	computeIndexLocation(org.eclipse.core.runtime.IPath containerPath, URL newIndexURL)	Compute the pre-built index location for a specified URL
final void	deleteIndexFiles()	Use deleteIndexFiles(IProgressMonitor)
void	deleteIndexFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
void	ensureIndexExists(IndexLocation indexLocation, org.eclipse.core.runtime.IPath containerPath)
Optional<Set<String>>	findMatchingIndexNames(QualifierQuery query)
Index	getIndex(IndexLocation indexLocation)	Returns the index for a given index location
Index	getIndex(org.eclipse.core.runtime.IPath containerPath, boolean reuseExistingFile, boolean createIfMissing)	Returns the index for a given project, according to the following algorithm: - if index is already in memory: answers this one back - if (reuseExistingFile) then read it and return this index and record it in memory - if (createIfMissing) then create a new empty index and record it in memory Warning: Does not check whether index is consistent (not being used)
Index	getIndex(org.eclipse.core.runtime.IPath containerPath, IndexLocation indexLocation, boolean reuseExistingFile, boolean createIfMissing)	Returns the index for a given project, according to the following algorithm: - if index is already in memory: answers this one back - if (reuseExistingFile) then read it and return this index and record it in memory - if (createIfMissing) then create a new empty index and record it in memory Warning: Does not check whether index is consistent (not being used)
Index[]	getIndexes(IndexLocation[] locations, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Returns all the existing indexes for a list of index locations.
Index	getIndexForUpdate(org.eclipse.core.runtime.IPath containerPath, boolean reuseExistingFile, boolean createIfMissing)
Optional<MetaIndex>	getMetaIndex()
SourceElementParser	getSourceElementParser(IJavaProject project, ISourceElementRequestor requestor)
void	indexAll(org.eclipse.core.resources.IProject project)	Trigger addition of the entire content of a project Note: the actual operation is performed in background
void	indexDocument(SearchDocument searchDocument, SearchParticipant searchParticipant, Index index, org.eclipse.core.runtime.IPath indexLocation)
void	indexLibrary(org.eclipse.core.runtime.IPath path, org.eclipse.core.resources.IProject requestingProject, URL indexURL)
void	indexLibrary(org.eclipse.core.runtime.IPath path, org.eclipse.core.resources.IProject requestingProject, URL indexURL, boolean updateIndex)	Trigger addition of a library to an index Note: the actual operation is performed in background
void	indexResolvedDocument(SearchDocument searchDocument, SearchParticipant searchParticipant, Index index, org.eclipse.core.runtime.IPath indexLocation)
void	indexSourceFolder(JavaProject javaProject, org.eclipse.core.runtime.IPath sourceFolder, char[][] inclusionPatterns, char[][] exclusionPatterns)	Index the content of the given source folder.
void	jobWasCancelled(org.eclipse.core.runtime.IPath containerPath)
protected void	moveToNextJob()	Advance to the next available job, once the current one has been completed.
protected void	notifyIdle(long idlingMilliSeconds)	No more job awaiting.
String	processName()	Name of the background process
Index	recreateIndex(org.eclipse.core.runtime.IPath containerPath)	Recreates the index for a given path, keeping the same read-write monitor.
void	remove(String containerRelativePath, org.eclipse.core.runtime.IPath indexedContainer)	Trigger removal of a resource to an index Note: the actual operation is performed in background
void	removeIndex(org.eclipse.core.runtime.IPath containerPath)	Removes the index for a given path.
void	removeIndexFamily(org.eclipse.core.runtime.IPath path)	Removes all indexes whose paths start with (or are equal to) the given path.
void	removeIndexPath(org.eclipse.core.runtime.IPath path)	Removes all indexes whose paths start with (or are equal to) the given path.
void	removeSourceFolderFromIndex(JavaProject javaProject, org.eclipse.core.runtime.IPath sourceFolder, char[][] inclusionPatterns, char[][] exclusionPatterns)	Remove the content of the given source folder from the index.
void	reset()	Flush current state
boolean	resetIndex(org.eclipse.core.runtime.IPath containerPath)	Resets the index for a given path.
void	saveIndex(Index index)
void	saveIndexes()	Commit all index memory changes to disk
void	savePreBuiltIndex(Index index)	saveIndex(Index) will only update the state if there are no other jobs running against the same underlying resource for this index.
void	scheduleDocumentIndexing(SearchDocument searchDocument, org.eclipse.core.runtime.IPath container, IndexLocation indexLocation, SearchParticipant searchParticipant)
String	toString()
void	updateParticipant(org.eclipse.core.runtime.IPath indexPath, org.eclipse.core.runtime.IPath containerPath)
org.eclipse.core.runtime.IStatus	waitForIndex(boolean enableIndexer, org.eclipse.core.runtime.IProgressMonitor monitor)	Waits until all indexing jobs are done or given monitor is cancelled.

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.search.processing.JobManager

awaitingJobsCount, currentJob, currentJobForced, disable, discardJobs, enable, hasPendingJobMatching, isEnabled, isJobWaiting, performConcurrentJob, request, requestIfNotWaiting, shutdown

Methods inherited from class java.lang.Object

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

Field Details

indexLocations

public SimpleLookupTable indexLocations

synchronized by IndexManager.this
key = containerPath, value = indexLocation path
indexLocation path is created by appending an index file name to the getJavaPluginWorkingLocation() path

SAVED_STATE

public static final Integer SAVED_STATE

UPDATING_STATE

public static final Integer UPDATING_STATE

UNKNOWN_STATE

public static final Integer UNKNOWN_STATE

REBUILDING_STATE

public static final Integer REBUILDING_STATE

REUSE_STATE

public static final Integer REUSE_STATE

MANAGE_PRODUCT_INDEXES_PROPERTY

public static final String MANAGE_PRODUCT_INDEXES_PROPERTY

See Also:

• Constant Field Values

INDEX_MANAGER_NOTIFY_IDLE_WAIT_PROPERTY

public static final String INDEX_MANAGER_NOTIFY_IDLE_WAIT_PROPERTY

See Also:

• Constant Field Values

DEBUG

public static boolean DEBUG

Constructor Details

IndexManager

public IndexManager()

Method Details

waitForIndex

public org.eclipse.core.runtime.IStatus waitForIndex(boolean enableIndexer,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Waits until all indexing jobs are done or given monitor is cancelled.

Parameters:

enableIndexer - true if this method should temporarily enable index manager and disable it again at the end (if the index manager was disabled before calling this method). If false is given and index manager is disabled, this method will block until index manager will be enabled again.

monitor - for cancellation

Returns:

Status#CANCEL_STATUS if the waiting was cancelled, Status#OK_STATUS otherwise

aboutToUpdateIndex

public void aboutToUpdateIndex(org.eclipse.core.runtime.IPath containerPath,
 Integer newIndexState)

addBinary

public void addBinary(org.eclipse.core.resources.IFile resource,
 org.eclipse.core.runtime.IPath containerPath)

Trigger addition of a resource to an index Note: the actual operation is performed in background

addSource

public void addSource(org.eclipse.core.resources.IFile resource,
 org.eclipse.core.runtime.IPath containerPath,
 SourceElementParser parser)

Trigger addition of a resource to an index Note: the actual operation is performed in background

cleanUpIndexes

public void cleanUpIndexes()

Removes unused indexes from disk.

computeIndexLocation

public IndexLocation computeIndexLocation(org.eclipse.core.runtime.IPath containerPath,
 URL newIndexURL)

Compute the pre-built index location for a specified URL

computeIndexLocation

public IndexLocation computeIndexLocation(org.eclipse.core.runtime.IPath containerPath)

deleteIndexFiles

public final void deleteIndexFiles()

Use deleteIndexFiles(IProgressMonitor)

deleteIndexFiles

public void deleteIndexFiles(org.eclipse.core.runtime.IProgressMonitor monitor)

ensureIndexExists

public void ensureIndexExists(IndexLocation indexLocation,
 org.eclipse.core.runtime.IPath containerPath)

getSourceElementParser

public SourceElementParser getSourceElementParser(IJavaProject project,
 ISourceElementRequestor requestor)

getIndex

public Index getIndex(IndexLocation indexLocation)

Returns the index for a given index location

Parameters:

indexLocation - The path of the index file

Returns:

The corresponding index or null if not found

getIndex

public Index getIndex(org.eclipse.core.runtime.IPath containerPath,
 boolean reuseExistingFile,
 boolean createIfMissing)

Returns the index for a given project, according to the following algorithm: - if index is already in memory: answers this one back - if (reuseExistingFile) then read it and return this index and record it in memory - if (createIfMissing) then create a new empty index and record it in memory Warning: Does not check whether index is consistent (not being used)

getIndex

public Index getIndex(org.eclipse.core.runtime.IPath containerPath,
 IndexLocation indexLocation,
 boolean reuseExistingFile,
 boolean createIfMissing)

Returns the index for a given project, according to the following algorithm: - if index is already in memory: answers this one back - if (reuseExistingFile) then read it and return this index and record it in memory - if (createIfMissing) then create a new empty index and record it in memory Warning: Does not check whether index is consistent (not being used)

getIndexes

public Index[] getIndexes(IndexLocation[] locations,
 org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Returns all the existing indexes for a list of index locations. Note that this may trigger some indexes recreation work
Method is synchronized because it uses this.indexLocations and this.indexes

Parameters:

locations - The list of of the index files path

Returns:

The corresponding indexes list.

getIndexForUpdate

public Index getIndexForUpdate(org.eclipse.core.runtime.IPath containerPath,
 boolean reuseExistingFile,
 boolean createIfMissing)

indexDocument

public void indexDocument(SearchDocument searchDocument,
 SearchParticipant searchParticipant,
 Index index,
 org.eclipse.core.runtime.IPath indexLocation)

indexResolvedDocument

public void indexResolvedDocument(SearchDocument searchDocument,
 SearchParticipant searchParticipant,
 Index index,
 org.eclipse.core.runtime.IPath indexLocation)

indexAll

public void indexAll(org.eclipse.core.resources.IProject project)

Trigger addition of the entire content of a project Note: the actual operation is performed in background

indexLibrary

public void indexLibrary(org.eclipse.core.runtime.IPath path,
 org.eclipse.core.resources.IProject requestingProject,
 URL indexURL)

indexLibrary

public void indexLibrary(org.eclipse.core.runtime.IPath path,
 org.eclipse.core.resources.IProject requestingProject,
 URL indexURL,
 boolean updateIndex)

Trigger addition of a library to an index Note: the actual operation is performed in background

indexSourceFolder

public void indexSourceFolder(JavaProject javaProject,
 org.eclipse.core.runtime.IPath sourceFolder,
 char[][] inclusionPatterns,
 char[][] exclusionPatterns)

Index the content of the given source folder.

jobWasCancelled

public void jobWasCancelled(org.eclipse.core.runtime.IPath containerPath)

moveToNextJob

protected void moveToNextJob()

Advance to the next available job, once the current one has been completed. Note: clients awaiting until the job count is zero are still waiting at this point.

Overrides:

moveToNextJob in class JobManager

notifyIdle

protected void notifyIdle(long idlingMilliSeconds)

No more job awaiting.

Specified by:

notifyIdle in class JobManager

processName

public String processName()

Name of the background process

Specified by:

processName in class JobManager

recreateIndex

public Index recreateIndex(org.eclipse.core.runtime.IPath containerPath)

Recreates the index for a given path, keeping the same read-write monitor. Returns the new empty index or null if it didn't exist before. Warning: Does not check whether index is consistent (not being used)

remove

public void remove(String containerRelativePath,
 org.eclipse.core.runtime.IPath indexedContainer)

Trigger removal of a resource to an index Note: the actual operation is performed in background

removeIndex

public void removeIndex(org.eclipse.core.runtime.IPath containerPath)

Removes the index for a given path. This is a no-op if the index did not exist.

removeIndexPath

public void removeIndexPath(org.eclipse.core.runtime.IPath path)

Removes all indexes whose paths start with (or are equal to) the given path.

removeIndexFamily

public void removeIndexFamily(org.eclipse.core.runtime.IPath path)

Removes all indexes whose paths start with (or are equal to) the given path.

removeSourceFolderFromIndex

public void removeSourceFolderFromIndex(JavaProject javaProject,
 org.eclipse.core.runtime.IPath sourceFolder,
 char[][] inclusionPatterns,
 char[][] exclusionPatterns)

Remove the content of the given source folder from the index.

reset

public void reset()

Flush current state

Overrides:

reset in class JobManager

resetIndex

public boolean resetIndex(org.eclipse.core.runtime.IPath containerPath)

Resets the index for a given path. Returns true if the index was reset, false otherwise.

savePreBuiltIndex

public void savePreBuiltIndex(Index index)
                       throws IOException

saveIndex(Index) will only update the state if there are no other jobs running against the same underlying resource for this index. Pre-built indexes must be in a REUSE_STATE state even if there is another job to run against it as the subsequent job will find the index and not save it in the right state. Refer to https://bugs.eclipse.org/bugs/show_bug.cgi?id=405932

Throws:

IOException

saveIndex

public void saveIndex(Index index)
               throws IOException

Throws:

IOException

saveIndexes

public void saveIndexes()

Commit all index memory changes to disk

scheduleDocumentIndexing

public void scheduleDocumentIndexing(SearchDocument searchDocument,
 org.eclipse.core.runtime.IPath container,
 IndexLocation indexLocation,
 SearchParticipant searchParticipant)

toString

public String toString()

Overrides:

toString in class JobManager

updateParticipant

public void updateParticipant(org.eclipse.core.runtime.IPath indexPath,
 org.eclipse.core.runtime.IPath containerPath)

findMatchingIndexNames

public Optional<Set<String>> findMatchingIndexNames(QualifierQuery query)

getMetaIndex

public Optional<MetaIndex> getMetaIndex()