Package com.intellij.openapi.vcs.checkin

Class CodeAnalysisBeforeCheckinHandler

java.lang.Object

com.intellij.openapi.vcs.checkin.CheckinHandler

com.intellij.openapi.vcs.checkin.CodeAnalysisBeforeCheckinHandler

public class CodeAnalysisBeforeCheckinHandler
extends CheckinHandler

The check-in handler which performs code analysis before check-in. Source code for this class is provided as a sample of using the CheckinHandler API.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.vcs.checkin.CheckinHandler

CheckinHandler.ReturnResult

Field Summary

Fields inherited from class com.intellij.openapi.vcs.checkin.CheckinHandler

DUMMY

Constructor Summary

Constructors

Constructor and Description
CodeAnalysisBeforeCheckinHandler(Project project, CheckinProjectPanel panel)

Method Summary

Modifier and Type	Method and Description
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.
RefreshableOnComponent	getBeforeCheckinConfigurationPanel() Returns the panel which is inserted in the "Before Check In" group box of the Checkin Project or Checkin File dialogs.

Methods inherited from class com.intellij.openapi.vcs.checkin.CheckinHandler

acceptExecutor, beforeCheckin, checkinFailed, checkinSuccessful, getAfterCheckinConfigurationPanel, getBeforeCheckinSettings, includedChangesChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeAnalysisBeforeCheckinHandler

public CodeAnalysisBeforeCheckinHandler(Project project,
                                        CheckinProjectPanel panel)

Method Detail

getBeforeCheckinConfigurationPanel

public RefreshableOnComponent getBeforeCheckinConfigurationPanel()

Description copied from class: CheckinHandler

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

Overrides:

getBeforeCheckinConfigurationPanel in class CheckinHandler

Returns:

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

beforeCheckin

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

Description copied from class: CheckinHandler

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.

Overrides:

beforeCheckin in class CheckinHandler

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.