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

Klasse JavaSearchParticipant

java.lang.Object
org.aspectj.org.eclipse.jdt.core.search.SearchParticipant
org.aspectj.org.eclipse.jdt.internal.core.search.JavaSearchParticipant
Alle implementierten Schnittstellen:
IParallelizable
public class JavaSearchParticipant extends SearchParticipant implements IParallelizable
A search participant describes a particular extension to a generic search mechanism, allowing thus to perform combined search actions which will involve all required participants A search scope defines which participants are involved. A search participant is responsible for holding index files, and selecting the appropriate ones to feed to index queries. It also can map a document path to an actual document (note that documents could live outside the workspace or no exist yet, and thus aren't just resources).

  • Konstruktordetails

    • JavaSearchParticipant

      public JavaSearchParticipant()

  • Methodendetails

    • beginSearching

      public void beginSearching()
      Beschreibung aus Klasse kopiert: SearchParticipant
      Notification that this participant's help is needed in a search.

      This method should be re-implemented in subclasses that need to do something when the participant is needed in a search.

      Setzt außer Kraft:
      beginSearching in Klasse SearchParticipant

    • doneSearching

      public void doneSearching()
      Beschreibung aus Klasse kopiert: SearchParticipant
      Notification that this participant's help is no longer needed.

      This method should be re-implemented in subclasses that need to do something when the participant is no longer needed in a search.

      Setzt außer Kraft:
      doneSearching in Klasse SearchParticipant

    • getDescription

      public String getDescription()
      Beschreibung aus Klasse kopiert: SearchParticipant
      Returns a displayable name of this search participant.

      This method should be re-implemented in subclasses that need to display a meaningful name.

      Setzt außer Kraft:
      getDescription in Klasse SearchParticipant
      Gibt zurück:
      the displayable name of this search participant

    • getDocument

      public SearchDocument getDocument(String documentPath)
      Beschreibung aus Klasse kopiert: SearchParticipant
      Returns a search document for the given path. The given document path is a string that uniquely identifies the document. Most of the time it is a workspace-relative path, but it can also be a file system path, or a path inside a zip file.

      Implementors of this method can either create an instance of their own subclass of SearchDocument or return an existing instance of such a subclass.

      Angegeben von:
      getDocument in Klasse SearchParticipant
      Parameter:
      documentPath - the path of the document.
      Gibt zurück:
      a search document

    • indexDocument

      public void indexDocument(SearchDocument document, org.eclipse.core.runtime.IPath indexPath)
      Beschreibung aus Klasse kopiert: SearchParticipant
      Indexes the given document in the given index. A search participant asked to index a document should parse it and call SearchDocument.addIndexEntry(char[], char[]) as many times as needed to add index entries to the index. If delegating to another participant, it should use the original index location (and not the delegatee's one). In the particular case of delegating to the default search participant (see SearchEngine.getDefaultSearchParticipant()), the provided document's path must be a path ending with one of the Java-like extensions or with '.class'.

      The given index location must represent a path in the file system to a file that either already exists or is going to be created. If it exists, it must be an index file, otherwise its data might be overwritten.

      Clients are not expected to call this method.

      Angegeben von:
      indexDocument in Klasse SearchParticipant
      Parameter:
      document - the document to index
      indexPath - the location in the file system to the index

    • indexResolvedDocument

      public void indexResolvedDocument(SearchDocument document, org.eclipse.core.runtime.IPath indexPath)
      Beschreibung aus Klasse kopiert: SearchParticipant
      Indexes the given resolved document in the given index. A search participant asked to index a resolved document should process it and call SearchDocument.addIndexEntry(char[], char[]) as many times as needed to add only those additional index entries which could not have been originally added to the index during a call to SearchParticipant.indexDocument(org.aspectj.org.eclipse.jdt.core.search.SearchDocument, org.eclipse.core.runtime.IPath). If delegating to another participant, it should use the original index location (and not the delegatee's one). In the particular case of delegating to the default search participant (see SearchEngine.getDefaultSearchParticipant()), the provided document's path must be a path ending with one of the Java-like extensions or with '.class'.

      The given index location must represent a path in the file system to a file that either already exists or is going to be created. If it exists, it must be an index file, otherwise its data might be overwritten.

      Clients are not expected to call this method.

      Setzt außer Kraft:
      indexResolvedDocument in Klasse SearchParticipant
      Parameter:
      document - the document to index
      indexPath - the location in the file system to the index

    • resolveDocument

      public void resolveDocument(SearchDocument document)
      Beschreibung aus Klasse kopiert: SearchParticipant
      Resolves the given document. A search participant asked to resolve a document should parse it and resolve the types and preserve enough state to be able to tend to a indexResolvedDocument call subsequently. This API is invoked without holding any index related locks or monitors.

      Clients are not expected to call this method.

      Setzt außer Kraft:
      resolveDocument in Klasse SearchParticipant
      Parameter:
      document - the document to resolve
      Siehe auch:

    • locateMatches

      public void locateMatches(SearchDocument[] indexMatches, SearchPattern pattern, IJavaSearchScope scope, SearchRequestor requestor, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
      Beschreibung aus Klasse kopiert: SearchParticipant
      Locates the matches in the given documents using the given search pattern and search scope, and reports them to the given search requestor. This method is called by the search engine once it has search documents matching the given pattern in the given search scope.

      Note that a participant (e.g. a JSP participant) can pre-process the contents of the given documents, create its own documents whose contents are Java compilation units and delegate the match location to the default participant (see SearchEngine.getDefaultSearchParticipant()). Passing its own SearchRequestor this participant can then map the match positions back to the original contents, create its own matches and report them to the original requestor.

      Implementors of this method should check the progress monitor for cancelation when it is safe and appropriate to do so. The cancelation request should be propagated to the caller by throwing OperationCanceledException.

      Angegeben von:
      locateMatches in Klasse SearchParticipant
      Parameter:
      indexMatches - the documents to locate matches in
      pattern - the search pattern to use when locating matches
      scope - the scope to limit the search to
      requestor - the requestor to report matches to
      monitor - the progress monitor to report progress to, or null if no progress should be reported
      Löst aus:
      org.eclipse.core.runtime.CoreException - if the requestor had problem accepting one of the matches

    • selectIndexes

      public org.eclipse.core.runtime.IPath[] selectIndexes(SearchPattern pattern, IJavaSearchScope scope)
      Beschreibung aus Klasse kopiert: SearchParticipant
      Returns the collection of index locations to consider when performing the given search query in the given scope. The search engine calls this method before locating matches.

      An index location represents a path in the file system to a file that holds index information.

      Clients are not expected to call this method.

      Angegeben von:
      selectIndexes in Klasse SearchParticipant
      Parameter:
      pattern - the search pattern to consider
      scope - the given search scope
      Gibt zurück:
      the collection of index paths to consider

    • selectIndexURLs

      public IndexLocation[] selectIndexURLs(SearchPattern pattern, IJavaSearchScope scope)

    • isParallelSearchSupported

      public boolean isParallelSearchSupported()
      Beschreibung aus Schnittstelle kopiert: IParallelizable
      Answers true if the current instance supports parallel index search
      Angegeben von:
      isParallelSearchSupported in Schnittstelle IParallelizable
      Gibt zurück:
      Returns true if the implementation is safe to be used in a parallel search.