Package com.intellij.openapi.vcs.merge

Interface MergeSession

All Known Subinterfaces:

MergeSessionEx

public interface MergeSession

Represents the state of a multiple file merge operation.

See Also:

MergeProvider2.createMergeSession(java.util.List<com.intellij.openapi.vfs.VirtualFile>)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MergeSession.Resolution

Method Summary

Modifier and Type	Method and Description
boolean	canMerge(VirtualFile file) Returns true if the given virtual file can be merged by its content.
void	conflictResolvedForFile(VirtualFile file, MergeSession.Resolution resolution) Called when the user executes one of the resolve actions (merge, accept yours, accept theirs) for a conflicting file.
ColumnInfo []	getMergeInfoColumns() Returns the list of additional columns to be displayed in the dialog.

Method Detail

getMergeInfoColumns

ColumnInfo [] getMergeInfoColumns()

Returns the list of additional columns to be displayed in the dialog. The Item type for the column should be VirtualFile.

Returns:

the list of columns, or an empty list if no additional columns should be displayed.

canMerge

boolean canMerge(VirtualFile file)

Returns true if the given virtual file can be merged by its content.

It means that the Merge dialog can be shown for this file, and Accept Yours/Theirs can be called on this file.

Note that MergeSessionEx can be used to Accept Yours/Theirs via a custom procedure, for example, via calling a VCS command. In this case this flag is ignored for Accept Yours/Theirs functionality, but it still allows or disallows to press Merge and show the Merge dialog.

Parameters:

file - a file with conflicts shown in the dialog.

Returns:

true if the merge dialog can be shown for this file, false otherwise.

conflictResolvedForFile

void conflictResolvedForFile(VirtualFile file,
                             MergeSession.Resolution resolution)

Called when the user executes one of the resolve actions (merge, accept yours, accept theirs) for a conflicting file. Note that if canMerge() is false for the file, the nothing is done by the idea, the implementer should perform necessary actions for conflict resolution itself.

Parameters:

file - the conflicting file.

resolution - the used resolution.