org.tmatesoft.svn.core.io
Interface ISVNDeltaConsumer

All Known Subinterfaces:

ISVNEditor, ISVNFileRevisionHandler

All Known Implementing Classes:

SVNAnnotationGenerator, SVNReplicationEditor

public interface ISVNDeltaConsumer

The ISVNDeltaConsumer interface is implemented by receivers of diff windows. For example, such consumers are passed to a delta generator when generating a series of diff windows from sources (text/binary streams).

Since:

1.2

Method Summary

void	applyTextDelta(java.lang.String path, java.lang.String baseChecksum) Starts applying text delta(s) to an opened file.
java.io.OutputStream	textDeltaChunk(java.lang.String path, SVNDiffWindow diffWindow) Collects a next delta chunk.
void	textDeltaEnd(java.lang.String path) Finalizes collecting text delta(s).

Method Detail

applyTextDelta

void applyTextDelta(java.lang.String path,
                    java.lang.String baseChecksum)
                    throws SVNException

Starts applying text delta(s) to an opened file.

Parameters:

path - a file path relative to the edit root directory

baseChecksum - an MD5 checksum for the base file contents (before the file is changed)

Throws:

SVNException - if the calculated base file checksum didn't match the expected baseChecksum

textDeltaChunk

java.io.OutputStream textDeltaChunk(java.lang.String path,
                                    SVNDiffWindow diffWindow)
                                    throws SVNException

Collects a next delta chunk. The return type is nomore relevant and is left only for backward compatibility. So, the return value may be just null. Otherwise if it's not null, the stream will be immediately closed.

If there are more than one windows for the file, this method is called several times.

Parameters:

path - a file path relative to the edit root directory

diffWindow - a next diff window

Returns:

an output stream

Throws:

SVNException

textDeltaEnd

void textDeltaEnd(java.lang.String path)
                  throws SVNException

Finalizes collecting text delta(s).

Parameters:

path - a file path relative to the edit root directory

Throws:

SVNException