Interface IStartSnapshotOperationStep

  • All Superinterfaces:
    ISnapshotOperation

    public interface IStartSnapshotOperationStep
    extends ISnapshotOperation
    Start step of snapshot operation.

    Once created, operation must be eventually either canceled or finished.

    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Detail

      • setProgressMonitor

        IStartSnapshotOperationStep setProgressMonitor​(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
        Sets the progress monitor. The operation will report progress to the given monitor.

        The snapshot operation supports cancellation. If the operation was canceled during execution of any step the subsequent create step and restore step will be skipped. During restoration of a single snapshot the cancellation is suppressed.

        Parameters:
        progressMonitor - the progress monitor, or null
        Returns:
        this
        Throws:
        IllegalStateException - if the operation was already started or canceled
      • start

        ICreateSnapshotsStep start()
        Starts the operation and returns the next step. This method consumes the receiver object. Subsequent calls must use the returned object.
        Returns:
        the next operation step, never null
        Throws:
        IllegalStateException - if the operation was already started or canceled
      • cancel

        void cancel()
        Cancels the operation, releasing locks for all affected projects.

        A canceled operation cannot be executed.

        Throws:
        IllegalStateException - if the operation was already started or canceled