Package com.intellij.openapi.vcs.checkin

Class CheckinHandler

java.lang.Object

com.intellij.openapi.vcs.checkin.CheckinHandler

Direct Known Subclasses:

CodeAnalysisBeforeCheckinHandler, TodoCheckinHandler, UnloadedModulesCompilationCheckinHandler

public abstract class CheckinHandler
extends java.lang.Object

A callback which can be used to extend the user interface of the Checkin Project/Checkin File dialogs and to perform actions before commit, on successful commit and on failed commit.

See Also:

BaseCheckinHandlerFactory.createHandler(CheckinProjectPanel, CommitContext), CodeAnalysisBeforeCheckinHandler, CheckinMetaHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckinHandler.ReturnResult

Field Summary

Fields

Modifier and Type	Field and Description
static CheckinHandler	DUMMY Return this handler if your handler shouldn't be created (for instance, your VCS is not active).

Constructor Summary

Constructors

Constructor and Description
CheckinHandler()

Method Summary

Modifier and Type	Method and Description
boolean	acceptExecutor(CommitExecutor executor) Allows to skip before checkin steps when is not applicable.
CheckinHandler.ReturnResult	beforeCheckin() Performs the before check-in processing.
CheckinHandler.ReturnResult	beforeCheckin(CommitExecutor executor, PairConsumer<java.lang.Object,java.lang.Object> additionalDataConsumer) Performs the before check-in processing when a custom commit executor is used.
void	checkinFailed(java.util.List<VcsException> exception) Performs the processing on failed check-in.
void	checkinSuccessful() Performs the processing on successful check-in.
RefreshableOnComponent	getAfterCheckinConfigurationPanel(Disposable parentDisposable) Returns the panel which is inserted in the "After Check In" group box of the Checkin Project or Checkin File dialogs.
RefreshableOnComponent	getBeforeCheckinConfigurationPanel() Returns the panel which is inserted in the "Before Check In" group box of the Checkin Project or Checkin File dialogs.
UnnamedConfigurable	getBeforeCheckinSettings()
void	includedChangesChanged() Called to notify handler that user has included/excluded some changes to/from commit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DUMMY

public static final CheckinHandler DUMMY

Return this handler if your handler shouldn't be created (for instance, your VCS is not active).

Constructor Detail

CheckinHandler

public CheckinHandler()

Method Detail

getBeforeCheckinConfigurationPanel

public RefreshableOnComponent getBeforeCheckinConfigurationPanel()

Returns the panel which is inserted in the "Before Check In" group box of the Checkin Project or Checkin File dialogs.

Returns:

the panel instance, or null if the handler does not provide any options to show in the "Before Check In" group.

getBeforeCheckinSettings

public UnnamedConfigurable getBeforeCheckinSettings()

getAfterCheckinConfigurationPanel

public RefreshableOnComponent getAfterCheckinConfigurationPanel(Disposable parentDisposable)

Returns the panel which is inserted in the "After Check In" group box of the Checkin Project or Checkin File dialogs.

Returns:

the panel instance, or null if the handler does not provide any options to show in the "After Check In" group.

beforeCheckin

public CheckinHandler.ReturnResult beforeCheckin(CommitExecutor executor,
                                                 PairConsumer<java.lang.Object,java.lang.Object> additionalDataConsumer)

Performs the before check-in processing when a custom commit executor is used. The method can use the CheckinProjectPanel instance passed to BaseCheckinHandlerFactory.createHandler(CheckinProjectPanel, CommitContext) to get information about the files to be checked in.

Parameters:

executor - the commit executor, or null if the standard commit operation is executed.

Returns:

the code indicating whether the check-in operation should be performed or aborted.

beforeCheckin

public CheckinHandler.ReturnResult beforeCheckin()

Performs the before check-in processing. The method can use the CheckinProjectPanel instance passed to BaseCheckinHandlerFactory.createHandler(CheckinProjectPanel, CommitContext) to get information about the files to be checked in.

Returns:

the code indicating whether the check-in operation should be performed or aborted.

checkinSuccessful

public void checkinSuccessful()

Performs the processing on successful check-in. The method can use the CheckinProjectPanel instance passed to BaseCheckinHandlerFactory.createHandler(CheckinProjectPanel, CommitContext) to get information about the checked in files.

checkinFailed

public void checkinFailed(java.util.List<VcsException> exception)

Performs the processing on failed check-in. The method can use the CheckinProjectPanel instance passed to BaseCheckinHandlerFactory.createHandler(CheckinProjectPanel, CommitContext) to get information about the checked in files.

Parameters:

exception - the list of VCS exceptions identifying the problems that occurred during the commit operation.

includedChangesChanged

public void includedChangesChanged()

Called to notify handler that user has included/excluded some changes to/from commit.

acceptExecutor

public boolean acceptExecutor(CommitExecutor executor)

Allows to skip before checkin steps when is not applicable. E.g., there should be no check for todos before shelf/create patch.

Parameters:

executor - current operation (null for commit)

Returns:

true if handler should be skipped