jetbrains.vcs.api.services

Interface CleanPatchService

All Superinterfaces:

VcsRemoteService, VcsService

public interface CleanPatchService
extends VcsService, VcsRemoteService

Vcs plugin provided service to implement clean checkout to a given revision.

Vcs plugin implementation may also provide IncrementalPatchService in case it supports incremental patch building

Created 22.10.12 12:48

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method and Description
void	buildCleanPatch(LowLevelPatchBuilder builder, java.lang.String toRevision) Creates a clean patch
boolean	isCacheAllowed()

Method Detail

isCacheAllowed

@VcsCacheable
boolean isCacheAllowed()

Returns:

true if VCS implementation allows client to cache patches, i.e. if patch (null, X) == patch (null, B) + patch(B, X) for all B before X

buildCleanPatch

void buildCleanPatch(@NotNull
                     LowLevelPatchBuilder builder,
                     @NotNull
                     java.lang.String toRevision)
              throws VcsException,
                     java.io.IOException

Creates a clean patch

Parameters:

builder - patch builder. Implementation will call LowLevelPatch.exit(String) or LowLevelPatch.fail(String) prior to LowLevelPatchBuilder.close()

toRevision - revision

Throws:

VcsException - on error

java.io.IOException - on error