Package com.intellij.openapi.vcs.update

Interface UpdateSession

All Known Implementing Classes:

UpdateSessionAdapter

public interface UpdateSession

A single update/integrate/status session.

See Also:

UpdateEnvironment.updateDirectories(com.intellij.openapi.vcs.FilePath[], com.intellij.openapi.vcs.update.UpdatedFiles, com.intellij.openapi.progress.ProgressIndicator, com.intellij.openapi.util.Ref<com.intellij.openapi.vcs.update.SequentialUpdatesContext>), UpdateSessionAdapter

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getAdditionalNotificationContent() Returns additional information which should be displayed in the post-update notification, or null.
java.util.List<VcsException>	getExceptions() Returns the list of exception objects representing the errors occurred during the update/integrate/status operation, or an empty list if no errors have occurred.
boolean	isCanceled() Checks if the update/integrate/status information was cancelled by the user.
void	onRefreshFilesCompleted() Called when the VFS refresh of the files affected by an update/integrate operation is complete.
default void	showNotification() Show notification with results of this UpdateSession, instead of the common standard notification and the standard file tree.

Method Detail

getExceptions

java.util.List<VcsException> getExceptions()

Returns the list of exception objects representing the errors occurred during the update/integrate/status operation, or an empty list if no errors have occurred.

Returns:

the list of errors.

onRefreshFilesCompleted

void onRefreshFilesCompleted()

Called when the VFS refresh of the files affected by an update/integrate operation is complete. Can be used, for example, to show a merge dialog for files which have been merged with conflicts.

isCanceled

boolean isCanceled()

Checks if the update/integrate/status information was cancelled by the user.

Returns:

true if the operation was cancelled, false otherwise.

getAdditionalNotificationContent

default java.lang.String getAdditionalNotificationContent()

Returns additional information which should be displayed in the post-update notification, or null.

showNotification

default void showNotification()

Show notification with results of this UpdateSession, instead of the common standard notification and the standard file tree.

See Also:

UpdateEnvironment.hasCustomNotification()