Interface IResourceContentExporterExtensionManager


  • public interface IResourceContentExporterExtensionManager
    IBmObjectExporter extension point. This API is introduced as temporary measure for external plugins to manage data during the export phase Should be used only if no other valid options are avaialable
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void afterExport​(IDtProject project, IBmObject bmObject, IBmObject clone, org.eclipse.core.resources.IFile file, Map<org.eclipse.core.resources.IFile,​byte[]> extraFiles)
      This method calls all the registered extensions after the export of the provided object.
      void afterExport​(org.eclipse.emf.ecore.EObject object, org.eclipse.core.resources.IFile file, Version runtimeVersion)
      This method calls all the registered extensions after the export of the provided object.
      void beforeExport​(IDtProject project, IBmObject bmObject, IBmObject clone, org.eclipse.core.resources.IFile file, Map<org.eclipse.core.resources.IFile,​byte[]> extraFiles)
      This method calls all the registered extensions before the export of the provided object.
      void beforeExport​(org.eclipse.emf.ecore.EObject object, org.eclipse.core.resources.IFile file, Version runtimeVersion)
      This method calls all the registered extensions before the export of the provided object.
      void registerExtension​(IResourceContentExporterExtension extension)
      Registers a new extension.
    • Method Detail

      • afterExport

        void afterExport​(org.eclipse.emf.ecore.EObject object,
                         org.eclipse.core.resources.IFile file,
                         Version runtimeVersion)
        This method calls all the registered extensions after the export of the provided object. This methods is called for non-BM stored objects/non-standard objects like spreadsheet document, etc.
        Parameters:
        object - The exported object. May not be null.
        file - The target workspace file. May not be null.
        runtimeVersion - The runtime version of the configuration. May not be null.
      • afterExport

        void afterExport​(IDtProject project,
                         IBmObject bmObject,
                         IBmObject clone,
                         org.eclipse.core.resources.IFile file,
                         Map<org.eclipse.core.resources.IFile,​byte[]> extraFiles)
        This method calls all the registered extensions after the export of the provided object.
        Parameters:
        dtProject - The project the exported object belongs to. May not be null.
        bmObject - The exported object. May not be null.
        clone - The cloned object that is actually serialized. The method implementations are allowed to modify the clone. May not be null.
        file - The target workspace file. May not be null
        extraFiles - The map to put the information about the extra files saved by the extesion where keys are the files and values are their signatures. May not be null.
      • beforeExport

        void beforeExport​(org.eclipse.emf.ecore.EObject object,
                          org.eclipse.core.resources.IFile file,
                          Version runtimeVersion)
        This method calls all the registered extensions before the export of the provided object. This methods is called for non-BM stored objects/non-standard objects like spreadsheet document, etc.
        Parameters:
        object - The exported object. May not be null
        file - The target workspace file. May not be null
        runtimeVersion - The runtime version of the configuration. May not be null
      • beforeExport

        void beforeExport​(IDtProject project,
                          IBmObject bmObject,
                          IBmObject clone,
                          org.eclipse.core.resources.IFile file,
                          Map<org.eclipse.core.resources.IFile,​byte[]> extraFiles)
        This method calls all the registered extensions before the export of the provided object.
        Parameters:
        bmObject - The exported. May not be null.
        clone - The cloned object that is actually serialized. The method implementations are allowed to modify the clone. May not be null.
        file - The target workspace file. May not be null.
        extraFiles - The map to put the information about the extra files saved by the extesion where keys are the files and values are their signatures. May not be null.
      • registerExtension

        void registerExtension​(IResourceContentExporterExtension extension)
        Registers a new extension. The client should call this method after the application start, preferrably - using service context management facilities
        Parameters:
        extension - The extension to register. May not be null