org.tmatesoft.svn.core

Class SVNAnnotationGenerator

public class SVNAnnotationGenerator extends Object implements ISVNFileRevisionHandler

The SVNAnnotationGenerator class is used to annotate files - that is to place author and revision information in-line for the specified file.

Since SVNAnnotationGenerator implements ISVNFileRevisionHandler, it is merely passed to a getFileRevisions() method of SVNRepository. After that you handle the resultant annotated file line-by-line providing an ISVNAnnotateHandler implementation to the reportAnnotations() method:

 import org.tmatesoft.svn.core.SVNAnnotationGenerator;
 import org.tmatesoft.svn.core.io.SVNRepositoryFactory;
 import org.tmatesoft.svn.core.io.SVNRepository;
 import org.tmatesoft.svn.core.wc.SVNAnnotateHandler;
 ...
 
     File tmpFile;
     SVNRepository repos;
     ISVNAnnotateHandler annotateHandler;
     ISVNEventHandler cancelHandler;
     long startRev = 0;
     long endRev = 150;
     ...
     
     SVNAnnotationGenerator generator = new SVNAnnotationGenerator(path, tmpFile, cancelHandler);
     try {
         repos.getFileRevisions("", startRev, endRev, generator);
         generator.reportAnnotations(annotateHandler, null);
     } finally {
         generator.dispose();
     }
 ...

Version: 1.1.1

Author: TMate Software Ltd.

Constructor Summary
SVNAnnotationGenerator(String path, File tmpDirectory, long startRevision, ISVNEventHandler cancelBaton)
Constructs an annotation generator object.
SVNAnnotationGenerator(String path, File tmpDirectory, long startRevision, boolean force, ISVNEventHandler cancelBaton)
Constructs an annotation generator object.
SVNAnnotationGenerator(String path, File tmpDirectory, long startRevision, boolean force, SVNDiffOptions diffOptions, ISVNEventHandler cancelBaton)
Constructs an annotation generator object.
Method Summary
voidapplyTextDelta(String token, String baseChecksum)
voidcloseRevision(String token)
Does nothing.
voiddispose()
Finalizes an annotation operation releasing resources involved by this generator.
voidopenRevision(SVNFileRevision fileRevision)
voidreportAnnotations(ISVNAnnotateHandler handler, String inputEncoding)
Dispatches file lines along with author & revision info to the provided annotation handler.
OutputStreamtextDeltaChunk(String token, SVNDiffWindow diffWindow)
voidtextDeltaEnd(String token)

Constructor Detail

SVNAnnotationGenerator

public SVNAnnotationGenerator(String path, File tmpDirectory, long startRevision, ISVNEventHandler cancelBaton)
Constructs an annotation generator object.

This constructor is equivalent to SVNAnnotationGenerator(path, tmpDirectory, startRevision, false, cancelBaton).

Parameters: path a file path (relative to a repository location) tmpDirectory a revision to stop at startRevision a start revision to begin annotation with cancelBaton a baton which is used to check if an operation is cancelled

SVNAnnotationGenerator

public SVNAnnotationGenerator(String path, File tmpDirectory, long startRevision, boolean force, ISVNEventHandler cancelBaton)
Constructs an annotation generator object.

Parameters: path a file path (relative to a repository location) tmpDirectory a revision to stop at startRevision a start revision to begin annotation with force forces binary files processing cancelBaton a baton which is used to check if an operation is cancelled

SVNAnnotationGenerator

public SVNAnnotationGenerator(String path, File tmpDirectory, long startRevision, boolean force, SVNDiffOptions diffOptions, ISVNEventHandler cancelBaton)
Constructs an annotation generator object.

Parameters: path a file path (relative to a repository location) tmpDirectory a revision to stop at startRevision a start revision to begin annotation with force forces binary files processing diffOptions diff options cancelBaton a baton which is used to check if an operation is cancelled

Method Detail

applyTextDelta

public void applyTextDelta(String token, String baseChecksum)

closeRevision

public void closeRevision(String token)
Does nothing.

Parameters: token

Throws: SVNException

dispose

public void dispose()
Finalizes an annotation operation releasing resources involved by this generator. Should be called after reportAnnotations().

openRevision

public void openRevision(SVNFileRevision fileRevision)

Parameters: fileRevision

Throws: SVNException if one of the following occurs:

reportAnnotations

public void reportAnnotations(ISVNAnnotateHandler handler, String inputEncoding)
Dispatches file lines along with author & revision info to the provided annotation handler.

If inputEncoding is null then "file.encoding" system property is used.

Parameters: handler an annotation handler that processes file lines with author & revision info inputEncoding a desired character set (encoding) of text lines

Throws: SVNException

textDeltaChunk

public OutputStream textDeltaChunk(String token, SVNDiffWindow diffWindow)

textDeltaEnd

public void textDeltaEnd(String token)
Copyright © 2004-2007 TMate Software Ltd. All Rights Reserved.