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

Class IndexRequest

java.lang.Object

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

All Implemented Interfaces:

IJob

Direct Known Subclasses:

BinaryContainer, IndexAllProject, IndexBinaryFolder, SaveIndex

public abstract class IndexRequest
extends Object
implements IJob

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.core.runtime.IPath	containerPath
protected boolean	isCancelled
protected IndexManager	manager

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.core.search.processing.IJob

CancelIfNotReady, COMPLETE, FAILED, ForceImmediate, WaitUntilReady

Constructor Summary

Constructors

Constructor	Description
IndexRequest(org.eclipse.core.runtime.IPath containerPath, IndexManager manager)

Method Summary

Modifier and Type	Method	Description
boolean	belongsTo(String projectNameOrJarPath)	Answer true if the job belongs to a given family (tag)
void	cancel()	Asks this job to cancel its execution.
void	ensureReadyToRun()	Ensures that this job is ready to run.
String	getJobFamily()	Returns this job's family
protected Integer	updatedIndexState()
boolean	waitNeeded()	Answers if we need some sleep after index write operations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.core.search.processing.IJob

execute

Field Details

isCancelled

protected volatile boolean isCancelled

containerPath

protected org.eclipse.core.runtime.IPath containerPath

manager

protected IndexManager manager

Constructor Details

IndexRequest

public IndexRequest(org.eclipse.core.runtime.IPath containerPath,
 IndexManager manager)

Method Details

belongsTo

public boolean belongsTo(String projectNameOrJarPath)

Description copied from interface: IJob

Answer true if the job belongs to a given family (tag)

Specified by:

belongsTo in interface IJob

cancel

public void cancel()

Description copied from interface: IJob

Asks this job to cancel its execution. The cancellation can take an undertermined amount of time.

Specified by:

cancel in interface IJob

ensureReadyToRun

public void ensureReadyToRun()

Description copied from interface: IJob

Ensures that this job is ready to run.

Specified by:

ensureReadyToRun in interface IJob

getJobFamily

public String getJobFamily()

Description copied from interface: IJob

Returns this job's family

Specified by:

getJobFamily in interface IJob

updatedIndexState

protected Integer updatedIndexState()

waitNeeded

public boolean waitNeeded()

Description copied from interface: IJob

Answers if we need some sleep after index write operations. Default implementation returns false.

Specified by:

waitNeeded in interface IJob

Returns:

true if the job manager should sleep a bit after this job is done to avoid IO tasks overloading OS (which could cause UI freezes etc).