CleanPatchService (javadoc 2024.12-174331 API)

All Superinterfaces:

VcsRemoteService, VcsService

All Known Implementing Classes:

CleanPatchServiceImplA
```
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`buildCleanPatch(LowLevelPatchBuilder builder, 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
                     String toRevision)
              throws VcsException,
                     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
    
    IOException - on error