Package org.eclipse.cdt.core.index.export

Class ExternalExportProjectProvider

java.lang.Object
org.eclipse.cdt.core.index.export.AbstractExportProjectProvider
org.eclipse.cdt.core.index.export.ExternalExportProjectProvider
All Implemented Interfaces:
IExportProjectProvider
public class ExternalExportProjectProvider extends AbstractExportProjectProvider
An IExportProjectProvider suitable for indexing an external folder. The arguments understood by this provider are
  • -source what will become the root of the indexed content
  • -include any preinclude files to configure the parser with
  • -id the id to write to the produce fragment

  • Field Details

  • Constructor Details

    • ExternalExportProjectProvider

      public ExternalExportProjectProvider()

  • Method Details

    • createProject

      public ICProject createProject() throws org.eclipse.core.runtime.CoreException
      Description copied from interface: IExportProjectProvider
      Creates, configures and returns a project for the indexer to index. This routine should not itself index the project, as a reindex will be performed by the framework. May not return null.
      Throws:
      org.eclipse.core.runtime.CoreException

    • getContentFolder

      protected org.eclipse.core.resources.IFolder getContentFolder()
      Returns the project folder the external content is stored in
      Returns:
      the project folder the external content is stored in

    • getAdditionalRawEntries

      protected List<IPathEntry> getAdditionalRawEntries()
      Get additional raw entries (above those added as part of the ExternalExportProjectProvider functionality)
      Returns:
      a list of additional entries to add to the project

    • getLocationConverter

      public IIndexLocationConverter getLocationConverter(ICProject cproject)
      Description copied from interface: IExportProjectProvider
      The location converter to use on export. This converter will be called to convert IIndexFileLocation's to an external form. The external form is implementation dependent.
      See Also:

    • getExportProperties

      public Map<String,String> getExportProperties()
      Description copied from interface: IExportProjectProvider
      Get a String to String map of properties to store with the index content. The export framework may ignore this if the index format does not support this. The PDOM format does support properties.
      Returns:
      a Map of String typed key value pairs representing ISV specific properties. This may return null.