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

Class PatternSearchJob

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.search.PatternSearchJob

All Implemented Interfaces:

IJob

Direct Known Subclasses:

SubTypeSearchJob

public class PatternSearchJob
extends Object
implements IJob

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	areIndexesReady
static final String	ENABLE_PARALLEL_SEARCH
static final boolean	ENABLE_PARALLEL_SEARCH_DEFAULT
protected AtomicLong	executionTime
protected SearchParticipant	participant
protected SearchPattern	pattern
protected IndexQueryRequestor	requestor
protected boolean	resolveDocumentForJar
protected boolean	resolveDocumentForSourceFiles
protected IJavaSearchScope	scope

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

CancelIfNotReady, COMPLETE, FAILED, ForceImmediate, WaitUntilReady

Constructor Summary

Constructors

Constructor	Description
PatternSearchJob(SearchPattern pattern, SearchParticipant participant, IJavaSearchScope scope, boolean resolveDocumentForJar, boolean resolveDocumentForSourceFiles, IndexQueryRequestor requestor)	Create a search job with the specified search pattern.
PatternSearchJob(SearchPattern pattern, SearchParticipant participant, IJavaSearchScope scope, IndexQueryRequestor requestor)

Method Summary

Modifier and Type	Method	Description
boolean	belongsTo(String jobFamily)	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.
boolean	execute(org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Execute the current job, answer whether it was successful.
Index[]	getIndexes(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
String	getJobFamily()	Returns this job's family
boolean	search(Index index, IndexQueryRequestor queryRequestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
String	toString()
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, wait, wait, wait

Field Details

pattern

protected SearchPattern pattern

scope

protected IJavaSearchScope scope

participant

protected SearchParticipant participant

requestor

protected IndexQueryRequestor requestor

resolveDocumentForJar

protected boolean resolveDocumentForJar

resolveDocumentForSourceFiles

protected boolean resolveDocumentForSourceFiles

areIndexesReady

protected boolean areIndexesReady

executionTime

protected AtomicLong executionTime

ENABLE_PARALLEL_SEARCH

public static final String ENABLE_PARALLEL_SEARCH

See Also:

• Constant Field Values

ENABLE_PARALLEL_SEARCH_DEFAULT

public static final boolean ENABLE_PARALLEL_SEARCH_DEFAULT

See Also:

• Constant Field Values

Constructor Details

PatternSearchJob

public PatternSearchJob(SearchPattern pattern,
 SearchParticipant participant,
 IJavaSearchScope scope,
 IndexQueryRequestor requestor)

PatternSearchJob

public PatternSearchJob(SearchPattern pattern,
 SearchParticipant participant,
 IJavaSearchScope scope,
 boolean resolveDocumentForJar,
 boolean resolveDocumentForSourceFiles,
 IndexQueryRequestor requestor)

Create a search job with the specified search pattern.

Parameters:

resolveDocumentForJar - whether to resolve the document name of a result entry if it comes to a JAR library.

resolveDocumentForSourceFiles - whether to resolve the document name of a result entry if it comes from a project's source files.

Method Details

belongsTo

public boolean belongsTo(String jobFamily)

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

execute

public boolean execute(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from interface: IJob

Execute the current job, answer whether it was successful.

Specified by:

execute in interface IJob

getIndexes

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

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).

getJobFamily

public String getJobFamily()

Description copied from interface: IJob

Returns this job's family

Specified by:

getJobFamily in interface IJob

search

public boolean search(Index index,
 IndexQueryRequestor queryRequestor,
 org.eclipse.core.runtime.IProgressMonitor progressMonitor)

toString

public String toString()

Overrides:

toString in class Object