org.aspectj.org.eclipse.jdt.internal.core.nd.indexer

Class Indexer

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.nd.indexer.Indexer

public final class Indexer
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Indexer.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static boolean	DEBUG_ALLOCATIONS
static boolean	DEBUG_INSERTIONS
static int	DEBUG_LOG_SIZE_MB
static boolean	DEBUG_SCHEDULING
static boolean	DEBUG_SELFTEST
static boolean	DEBUG_TIMING

Constructor Summary

Constructors

Constructor and Description
Indexer(Nd toPopulate, IWorkspaceRoot workspaceRoot)

Method Summary

Modifier and Type	Method and Description
void	addListener(Indexer.Listener newListener) Adds the given listener.
protected void	deleteResource(NdResourceFile toDelete, IProgressMonitor monitor) Performs a non-atomic delete of the given resource file.
void	enableAutomaticIndexing(boolean enabled) Enables or disables the "rescanAll" method.
static Indexer	getInstance()
void	makeDirty(IPath location) Dirties the given filesystem location.
void	makeDirty(IProject project) Schedules a rescan of the given project.
void	makeWorkspacePathDirty(IPath pathToRescan) Schedules a rescan of the given path (which may be either a workspace path or an absolute path on the local filesystem).
void	rebuildIndex(IProgressMonitor monitor)
void	removeListener(Indexer.Listener oldListener)
void	requestRebuildIndex()
void	rescan(IProgressMonitor monitor)
void	rescanAll()
void	waitForIndex(int waitingPolicy, IProgressMonitor monitor)
void	waitForIndex(IProgressMonitor monitor)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

DEBUG_ALLOCATIONS

public static boolean DEBUG_ALLOCATIONS

DEBUG_TIMING

public static boolean DEBUG_TIMING

DEBUG_SCHEDULING

public static boolean DEBUG_SCHEDULING

DEBUG_INSERTIONS

public static boolean DEBUG_INSERTIONS

DEBUG_SELFTEST

public static boolean DEBUG_SELFTEST

DEBUG_LOG_SIZE_MB

public static int DEBUG_LOG_SIZE_MB

Constructor Detail

Indexer

public Indexer(Nd toPopulate,
               IWorkspaceRoot workspaceRoot)

Method Detail

getInstance

public static Indexer getInstance()

enableAutomaticIndexing

public void enableAutomaticIndexing(boolean enabled)

Enables or disables the "rescanAll" method. When set to false, rescanAll does nothing and indexing will only be triggered when invoking waitForIndex(IProgressMonitor).

Normally the indexer runs automatically and asynchronously when resource changes occur. However, if this variable is set to false the indexer only runs when someone invokes waitForIndex(IProgressMonitor). This can be used to eliminate race conditions when running the unit tests, since indexing will not occur unless it is triggered explicitly.

Synchronize on automaticIndexingMutex before accessing.

rescan

public void rescan(IProgressMonitor monitor)
            throws CoreException

Throws:

CoreException

deleteResource

protected void deleteResource(NdResourceFile toDelete,
                              IProgressMonitor monitor)

Performs a non-atomic delete of the given resource file. First, it marks the file as being invalid (by clearing out its timestamp). Then it deletes the children of the resource file, one child at a time. Once all the children are deleted, the resource itself is deleted. The result on the database is exactly the same as if the caller had called toDelete.delete(), but doing it this way ensures that a write lock will never be held for a nontrivial amount of time.

rescanAll

public void rescanAll()

addListener

public void addListener(Indexer.Listener newListener)

Adds the given listener. It will be notified when Nd changes. No strong references will be retained to the listener.

removeListener

public void removeListener(Indexer.Listener oldListener)

waitForIndex

public void waitForIndex(IProgressMonitor monitor)

waitForIndex

public void waitForIndex(int waitingPolicy,
                         IProgressMonitor monitor)

rebuildIndex

public void rebuildIndex(IProgressMonitor monitor)
                  throws CoreException

Throws:

CoreException

requestRebuildIndex

public void requestRebuildIndex()

makeDirty

public void makeDirty(IPath location)

Dirties the given filesystem location. This must point to a single file (not a folder) that needs to be rescanned. The file may have been added, removed, or changed.

Parameters:

location - an absolute filesystem location

makeDirty

public void makeDirty(IProject project)

Schedules a rescan of the given project.

makeWorkspacePathDirty

public void makeWorkspacePathDirty(IPath pathToRescan)

Schedules a rescan of the given path (which may be either a workspace path or an absolute path on the local filesystem). This may point to either a single file or a folder that needs to be rescanned. Any resource that has this path as a prefix will be rescanned.

Parameters:

pathToRescan -