Interface IExternalMergeToolProvider

All Superinterfaces:
IManagedService
All Known Implementing Classes:
ExternalMergeToolManager

public interface IExternalMergeToolProvider extends IManagedService
The provider of external comparison and merge tools. Provides information about all external tools, about applicable external tools for two-/three-way comparison/merge.
  • Method Details

    • getExternalMergeToolByName

      Optional<ExternalMergeToolConfiguration> getExternalMergeToolByName(String toolName)
      Returns the external merge tool by name.
      Parameters:
      toolName - the external merge tool name to get for, cannot be null
      Returns:
    • getExternalMergeTools

      List<ExternalMergeToolConfiguration> getExternalMergeTools()
      Returns all external merge tools. Returned collection is unmodifiable.
      Returns:
      all external merge tools, never null
    • getTwoWayComparisonExternalTool

      ExternalMergeToolConfiguration getTwoWayComparisonExternalTool()
      Returns the two-way comparison external tool.
      Returns:
      the two-way comparison external tool configuration, may be null
    • getTwoWayMergeExternalTool

      ExternalMergeToolConfiguration getTwoWayMergeExternalTool()
      Returns the two-way merge external tool.
      Returns:
      the two-way merge external tool configuration, may be null
    • getThreeWayComparisonExternalTool

      ExternalMergeToolConfiguration getThreeWayComparisonExternalTool()
      Returns the three-way comparison external tool.
      Returns:
      the three-way comparison external tool configuration, may be null
    • getThreeWayMergeExternalTool

      ExternalMergeToolConfiguration getThreeWayMergeExternalTool()
      Returns the three-way merge external tool.
      Returns:
      the three-way merge external tool, may be null
    • mergeUsingExternalToolByDefault

      boolean mergeUsingExternalToolByDefault()
      Tells whether to merge using an external tool by default.
      Returns:
      true if need to merge using an external tool by default, false otherwise
    • getMergeUsingExternalToolByDefaultMode

      IExternalMergeToolProvider.MergeUsingExternalToolByDefaultMode getMergeUsingExternalToolByDefaultMode()
      Returns the mode how to merge using an external tool by default.
      Returns:
      the mode how to merge using an external tool by default, never null
    • getSessionTimeout

      int getSessionTimeout()
      Returns session timeout for all external tools
      Returns:
      session timeout, a positive integer