Interface IDtComparisonEditorInput

  • All Superinterfaces:
    org.eclipse.core.runtime.IAdaptable, org.eclipse.ui.IEditorInput

    public interface IDtComparisonEditorInput
    extends org.eclipse.ui.IEditorInput
    The input for the DT comparison/merge editor.
    • Method Detail

      • getDescriptors

        List<CompareMergeProcessDescriptor> getDescriptors()
        Returns the compare/merge process descriptors.
        Returns:
        the compare/merge process descriptors, never null
      • getUuid

        UUID getUuid()
        Returns the input's UUID.
        Returns:
        the input's UUID, not null
      • isNoMerge

        boolean isNoMerge()
        Returns the value of the 'noMerge' flag, the flag defines whether it is possible to run merge.
        Returns:
        the value of the 'noMerge' flag
      • getMergeCallback

        IMergeCallback getMergeCallback()
        Returns the merge process callback if it was specified.
        Returns:
        the merge process call back or null if it was not specified
      • getInitialComparisonFilterKind

        ComparisonFilterKind getInitialComparisonFilterKind()
        Returns the initial comparison filter kind if it was specified.
        Returns:
        the initial comparison filter kind or null it was not specified
      • setInitialComparisonFilterKind

        void setInitialComparisonFilterKind​(ComparisonFilterKind value)
        Sets the initial comparison filter kind to the specified value.
        Parameters:
        value - the value of the initial comparison filter kind to set, can not be null
      • getMainComparisonSideName

        String getMainComparisonSideName()
        Returns the main comparison side name to show it on the UI.
        Returns:
        the main comparison side name, never null
      • getOtherComparisonSideName

        String getOtherComparisonSideName()
        Returns the other comparison side name to show it on the UI.
        Returns:
        the other comparison side name, never null
      • getEditorName

        String getEditorName()
        Returns the comparison editor name.
        Returns:
        the comparison editor name, can not be null
      • runInitialComparison

        boolean runInitialComparison()
        Determines whether to run the initial comparison after the editor will be opened.
        Returns:
        true if it need to run the initial comparison after the editor will be opened
      • setRunInitialComparison

        void setRunInitialComparison​(boolean value)
        Sets the 'runInitialComparison' flag to the specified value.
        Parameters:
        value - true to set 'runInitialComparison' flag true
      • isMultiProjectComparison

        boolean isMultiProjectComparison()
        Checks is a multiproject comparison.
        Returns:
        true if multiproject sources are compared, otherwise false
      • putRestoredMergeSettings

        void putRestoredMergeSettings​(ComparisonProcessHandle handle,
                                      RestoredMergeSettings restoredSettings)
        Adding recovered merge settings for a specific session.
        Parameters:
        handle - the comparison process handle, cannot be null
        restoredSettings - restored merge settings container, cannot be null
      • getRestoredMergeSettings

        RestoredMergeSettings getRestoredMergeSettings​(ComparisonProcessHandle handle)
        Returns the restored merge settings for the given comparison session.
        Parameters:
        the - comparison process handle, cannot be null
        Returns:
        restoredSettings restored merge settings container, can be null
      • clearRestoredMergeSettings

        void clearRestoredMergeSettings()
        Deletes all restored merge settings.
      • getMergeConfirmationMessage

        String getMergeConfirmationMessage()
        Returns the confirmation message before merge start. If no confirmation message is specified the default message will be used.
        Returns:
        the confirmation message before merge start, may be null
      • setMergeConfirmationMessage

        void setMergeConfirmationMessage​(String mergeConfirmationMessage)
        Sets the confirmation message before merge start. If no confirmation message is specified the default message will be used.
        Parameters:
        mergeConfirmationMessage - the confirmation message before merge start, cannot be null