Package com.intellij.openapi.vcs.checkin

Interface CheckinEnvironment

All Known Implementing Classes:

CvsCheckinEnvironment, GitCheckinEnvironment, HgCheckinEnvironment, SvnCheckinEnvironment

public interface CheckinEnvironment

Interface for performing VCS checkin / commit / submit operations.

See Also:

AbstractVcs.getCheckinEnvironment()

Method Summary

Modifier and Type	Method and Description
default java.util.List<VcsException>	commit(java.util.List<Change> changes, java.lang.String preparedComment)
default java.util.List<VcsException>	commit(java.util.List<Change> changes, java.lang.String commitMessage, CommitContext commitContext, java.util.Set<java.lang.String> feedback)
default RefreshableOnComponent	createAdditionalOptionsPanel(CheckinProjectPanel panel, PairConsumer<java.lang.Object,java.lang.Object> additionalDataConsumer) Deprecated. use createCommitOptions(CheckinProjectPanel, CommitContext)
default RefreshableOnComponent	createCommitOptions(CheckinProjectPanel commitPanel, CommitContext commitContext)
java.lang.String	getCheckinOperationName()
default java.lang.String	getDefaultMessageFor(FilePath [] filesToCheckin)
java.lang.String	getHelpId()
boolean	isRefreshAfterCommitNeeded()
default boolean	keepChangeListAfterCommit(ChangeList changeList) Deprecated. use VcsConfiguration.REMOVE_EMPTY_INACTIVE_CHANGELISTS
java.util.List<VcsException>	scheduleMissingFileForDeletion(java.util.List<FilePath> files)
java.util.List<VcsException>	scheduleUnversionedFilesForAddition(java.util.List<VirtualFile> files)

Method Detail

createCommitOptions

default RefreshableOnComponent createCommitOptions(CheckinProjectPanel commitPanel,
                                                   CommitContext commitContext)

createAdditionalOptionsPanel

@Deprecated
default RefreshableOnComponent createAdditionalOptionsPanel(CheckinProjectPanel panel,
                                                            PairConsumer<java.lang.Object,java.lang.Object> additionalDataConsumer)

Deprecated. use createCommitOptions(CheckinProjectPanel, CommitContext)

getDefaultMessageFor

default java.lang.String getDefaultMessageFor(FilePath [] filesToCheckin)

getHelpId

java.lang.String getHelpId()

getCheckinOperationName

java.lang.String getCheckinOperationName()

commit

default java.util.List<VcsException> commit(java.util.List<Change> changes,
                                            java.lang.String preparedComment)

commit

default java.util.List<VcsException> commit(java.util.List<Change> changes,
                                            java.lang.String commitMessage,
                                            CommitContext commitContext,
                                            java.util.Set<java.lang.String> feedback)

scheduleMissingFileForDeletion

java.util.List<VcsException> scheduleMissingFileForDeletion(java.util.List<FilePath> files)

scheduleUnversionedFilesForAddition

java.util.List<VcsException> scheduleUnversionedFilesForAddition(java.util.List<VirtualFile> files)

keepChangeListAfterCommit

@Deprecated
default boolean keepChangeListAfterCommit(ChangeList changeList)

Deprecated. use VcsConfiguration.REMOVE_EMPTY_INACTIVE_CHANGELISTS

isRefreshAfterCommitNeeded

boolean isRefreshAfterCommitNeeded()

Returns:

true if VFS refresh has to be performed after commit, because files might have changed during commit (for example, due to keyword substitution in SVN or read-only status in Perforce).