org.eclipse.jgit.iplog

Class IpLogGenerator

java.lang.Object

org.eclipse.jgit.iplog.IpLogGenerator

public class IpLogGenerator
extends Object

Creates an Eclipse IP log in XML format.

See Also:

IP log XSD

Constructor Summary

Constructors

Constructor and Description
IpLogGenerator() Create an empty generator.

Method Summary

Methods

Modifier and Type	Method and Description
void	scan(Repository repo, RevCommit startCommit, String version) Scan a Git repository's history to compute the changes within it.
void	setCharacterEncoding(String encodingName) Set the character encoding used to write the output file.
void	writeTo(OutputStream out) Dump the scanned information into an XML file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IpLogGenerator

public IpLogGenerator()

Create an empty generator.

Method Detail

setCharacterEncoding

public void setCharacterEncoding(String encodingName)

Set the character encoding used to write the output file.

Parameters:

encodingName - the character set encoding name.

scan

public void scan(Repository repo,
        RevCommit startCommit,
        String version)
          throws IOException,
                 ConfigInvalidException

Scan a Git repository's history to compute the changes within it.

Parameters:

repo - the repository to scan.

startCommit - commit the IP log is needed for.

version - symbolic label for the version.

Throws:

IOException - the repository cannot be read.

ConfigInvalidException - the .eclipse_iplog file present at the top level of startId is not a valid configuration file.

writeTo

public void writeTo(OutputStream out)
             throws IOException

Dump the scanned information into an XML file.

Parameters:

out - the file stream to write to. The caller is responsible for closing the stream upon completion.

Throws:

IOException - the stream cannot be written.