Package com.intellij.openapi.vcs.update

Interface UpdateEnvironment

All Known Implementing Classes:

AbstractSvnUpdateIntegrateEnvironment, CvsStatusEnvironment, CvsUpdateEnvironment, GitUpdateEnvironment, HgUpdateEnvironment, SvnIntegrateEnvironment, SvnUpdateEnvironment

public interface UpdateEnvironment

Implemented by a VCS integration to support "Update" and optionally "Integrate" and "Check Status" operations for project, directories or files.

See Also:

AbstractVcs.getUpdateEnvironment(), AbstractVcs.getIntegrateEnvironment(), AbstractVcs.getStatusEnvironment()

Method Summary

Modifier and Type	Method and Description
Configurable	createConfigurable(java.util.Collection<FilePath> files) Allows to show a settings dialog for the operation.
void	fillGroups(UpdatedFiles updatedFiles) Called before the update operation to register file status groups in addition to standard file status groups registered in UpdatedFiles.create().
default boolean	hasCustomNotification() Returns true if the UpdateSession created by this UpdateEnvironment will show a custom notification instead of the standard one.
UpdateSession	updateDirectories(FilePath [] contentRoots, UpdatedFiles updatedFiles, ProgressIndicator progressIndicator, Ref<SequentialUpdatesContext> context) Performs the update/integrate/status operation.
boolean	validateOptions(java.util.Collection<FilePath> roots)

Method Detail

fillGroups

void fillGroups(UpdatedFiles updatedFiles)

Called before the update operation to register file status groups in addition to standard file status groups registered in UpdatedFiles.create(). The implementation can be left empty if the VCS doesn't support any non-standard file statuses.

Parameters:

updatedFiles - the holder for the results of the update/integrate/status operation.

updateDirectories

UpdateSession updateDirectories(FilePath [] contentRoots,
                                UpdatedFiles updatedFiles,
                                ProgressIndicator progressIndicator,
                                Ref<SequentialUpdatesContext> context)
                         throws ProcessCanceledException

Performs the update/integrate/status operation.

Parameters:

contentRoots - the content roots for which update/integrate/status was requested by the user.

updatedFiles - the holder for the results of the update/integrate/status operation.

progressIndicator - the indicator that can be used to report the progress of the operation.

context - in-out parameter: a link between several sequential update operations (that can be triggered by one update action)

Returns:

the update session instance, which can be used to get information about errors that have occurred during the operation and to perform additional post-update processing.

Throws:

ProcessCanceledException - if the update operation has been cancelled by the user. Alternatively, cancellation can be reported by returning true from UpdateSession.isCanceled().

createConfigurable

Configurable createConfigurable(java.util.Collection<FilePath> files)

Allows to show a settings dialog for the operation.

Parameters:

files - the content roots for which update/integrate/status will be performed.

Returns:

the settings dialog instance, or null if the VCS doesn't provide a settings dialog for this operation.

validateOptions

boolean validateOptions(java.util.Collection<FilePath> roots)

hasCustomNotification

default boolean hasCustomNotification()

Returns true if the UpdateSession created by this UpdateEnvironment will show a custom notification instead of the standard one.