Package com.intellij.openapi.vcs.checkin

Class CheckinHandlerFactory

java.lang.Object

com.intellij.openapi.vcs.checkin.CheckinHandlerFactory

All Implemented Interfaces:

BaseCheckinHandlerFactory

Direct Known Subclasses:

CodeAnalysisCheckinHandlerFactory, ExternalToolsCheckinHandlerFactory, TaskCheckinHandlerFactory, TodoCheckinHandlerFactory, UnloadedModulesCompilationCheckinHandler.Factory, UpdateCopyrightCheckinHandlerFactory

public abstract class CheckinHandlerFactory
extends java.lang.Object
implements BaseCheckinHandlerFactory

Factory which provides callbacks to run before and after checkin operations. !! This factory is loaded on first commit should NOT be used from VCS plugins use VcsCheckinHandlerFactory implementations instead, define through EP "com.intellij.checkinHandlerFactory" they would automatically would be registered in AbstractVcs.activate() and unregistered in AbstractVcs.deactivate()

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<CheckinHandlerFactory>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
CheckinHandlerFactory()

Method Summary

Modifier and Type	Method and Description
abstract CheckinHandler	createHandler(CheckinProjectPanel panel, CommitContext commitContext) Creates a handler for a single Checkin Project or Checkin File operation.
BeforeCheckinDialogHandler	createSystemReadyHandler(Project project)

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<CheckinHandlerFactory> EP_NAME

Constructor Detail

CheckinHandlerFactory

public CheckinHandlerFactory()

Method Detail

createHandler

public abstract CheckinHandler createHandler(CheckinProjectPanel panel,
                                             CommitContext commitContext)

Creates a handler for a single Checkin Project or Checkin File operation.

Specified by:

createHandler in interface BaseCheckinHandlerFactory

Parameters:

panel - the class which can be used to retrieve information about the files to be committed, and to get or set the commit message.

Returns:

the handler instance.

createSystemReadyHandler

public BeforeCheckinDialogHandler createSystemReadyHandler(Project project)

Specified by:

createSystemReadyHandler in interface BaseCheckinHandlerFactory