Package com.e1c.langtool.sync

Interface ResourceSynchronizer

All Known Implementing Classes:
AbstractBmObjectSynchronizer, AbstractExternalPropertySynchronizer, AbstractHtmlPageSynchronizer, AdditionalIndexSynchronizer, AsIsResourceSynchronizer, BaseFormObjectSynchronizer, BmObjectDefaultSynchronizer, DcsTemplateSynchronizer, ExternalPropertySynchronizer, FormObjectSynchronizer, FormPictureSynchronizer, HelpPageSynchronizer, HelpPicturesSynchronizer, HtmlDocSynchronizer, HtmlPageSynchronizer, MdObjectSynchronizer, MdPictureSynchronizer, ModuleSynchronizer, MoxelSynchronizer, NoActionSynchronizer, ReplacebleExternalPropertySynchronizer, SchemePictureSynchronizer, TemplatePicturesSynchronizer
public interface ResourceSynchronizer
Common Interface for synchronizers of project resources. Implementations must to contribute to extension point com.e1c.langtool.sync.synchronizer.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Gets the unique ID of the synchronizer.
    default Collection<org.eclipse.core.resources.IFile>
    remove(org.eclipse.core.resources.IFile sourceFile, ITranslatingProject sourceProject, ITranslatedProject target, SyncSession session, org.eclipse.core.runtime.IProgressMonitor monitor)
    Removes the files in target project by given deleted source file.
    Collection<org.eclipse.core.resources.IResource>
    synchronize(org.eclipse.core.resources.IFile sourceFile, ITranslatingProject sourceProject, ITranslatedProject target, SyncSession session, org.eclipse.core.runtime.IProgressMonitor monitor)
    Synchronize given source file to target project with translating.

  • Method Details

    • getId

      String getId()
      Gets the unique ID of the synchronizer.
      Returns:
      the ID of the synchronizer, cannot return null.

    • synchronize

      Collection<org.eclipse.core.resources.IResource> synchronize(org.eclipse.core.resources.IFile sourceFile, ITranslatingProject sourceProject, ITranslatedProject target, SyncSession session, org.eclipse.core.runtime.IProgressMonitor monitor)
      Synchronize given source file to target project with translating.
      Parameters:
      sourceFile - the source file
      sourceProject - the source project
      target - the target
      session - the session
      monitor - the monitor
      Returns:
      the collection of synchronized files in target project, cannot return null.

    • remove

      default Collection<org.eclipse.core.resources.IFile> remove(org.eclipse.core.resources.IFile sourceFile, ITranslatingProject sourceProject, ITranslatedProject target, SyncSession session, org.eclipse.core.runtime.IProgressMonitor monitor)
      Removes the files in target project by given deleted source file. Synchronizer may not specify remove method, in this case all previously synchronized resources will be removed from the target project.
      Parameters:
      sourceFile - the source file
      sourceProject - the source project
      target - the target
      session - the session
      monitor - the monitor
      Returns:
      the collection of removed files in target project, cannot return null.