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

Class JobManager

java.lang.Object

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

Direct Known Subclasses:

IndexManager

public abstract class JobManager
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	VERBOSE

Constructor Summary

Constructors

Constructor	Description
JobManager()

Method Summary

Modifier and Type	Method	Description
int	awaitingJobsCount()	Answer the amount of awaiting jobs.
IJob	currentJob()	Answers the first job in the queue, or null if there is no job available or index manager is disabled Until the job has completed, the job manager will keep answering the same job.
IJob	currentJobForced()	Answers the first job in the queue, or null if there is no job available, independently on job manager enablement state.
void	disable()
void	discardJobs(String jobFamily)	Remove the index from cache for a given project.
void	enable()
protected boolean	hasPendingJobMatching(Predicate<IJob> request)
boolean	isEnabled()
protected boolean	isJobWaiting(IJob request)
protected void	moveToNextJob()	Advance to the next available job, once the current one has been completed.
protected abstract void	notifyIdle(long idlingMilliSeconds)	When idle, give chance to do something
boolean	performConcurrentJob(IJob searchJob, int waitingPolicy, org.eclipse.core.runtime.IProgressMonitor monitor)	This API is allowing to run one job in concurrence with background processing.
abstract String	processName()
void	request(IJob job)
void	requestIfNotWaiting(IJob job)	Schedules given job for execution is there is no equal jobs waiting in the queue already
void	reset()	Flush current state
void	shutdown()	Stop background processing, and wait until the current job is completed before returning
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

VERBOSE

public static boolean VERBOSE

Constructor Details

JobManager

public JobManager()

Method Details

awaitingJobsCount

public int awaitingJobsCount()

Answer the amount of awaiting jobs.

currentJob

public IJob currentJob()

Answers the first job in the queue, or null if there is no job available or index manager is disabled Until the job has completed, the job manager will keep answering the same job.

currentJobForced

public IJob currentJobForced()

Answers the first job in the queue, or null if there is no job available, independently on job manager enablement state. Until the job has completed, the job manager will keep answering the same job.

disable

public void disable()

isEnabled

public boolean isEnabled()

Returns:

true if the job manager is enabled

discardJobs

public void discardJobs(String jobFamily)

Remove the index from cache for a given project. Passing null as a job family discards them all.

enable

public void enable()

isJobWaiting

protected boolean isJobWaiting(IJob request)

hasPendingJobMatching

protected boolean hasPendingJobMatching(Predicate<IJob> request)

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.

notifyIdle

protected abstract void notifyIdle(long idlingMilliSeconds)

When idle, give chance to do something

performConcurrentJob

public boolean performConcurrentJob(IJob searchJob,
 int waitingPolicy,
 org.eclipse.core.runtime.IProgressMonitor monitor)

This API is allowing to run one job in concurrence with background processing. Indeed since other jobs are performed in background, resource sharing might be an issue.Therefore, this functionality allows a given job to be run without colliding with background ones. Note: multiple thread might attempt to perform concurrent jobs at the same time, and should synchronize (it is deliberately left to clients to decide whether concurrent jobs might interfere or not. In general, multiple read jobs are ok). Waiting policy can be: IJobConstants.ForceImmediateSearch IJobConstants.CancelIfNotReadyToSearch IJobConstants.WaitUntilReadyToSearch

processName

public abstract String processName()

requestIfNotWaiting

public void requestIfNotWaiting(IJob job)

Schedules given job for execution is there is no equal jobs waiting in the queue already

Parameters:

job - a job to schedule (or not)

See Also:

• isJobWaiting(IJob)

request

public void request(IJob job)

reset

public void reset()

Flush current state

shutdown

public void shutdown()

Stop background processing, and wait until the current job is completed before returning

toString

public String toString()

Overrides:

toString in class Object