net.sf.statcvs.model

Class Commit

Implemented Interfaces:
Comparable

public class Commit
extends Object
implements Comparable

Represents a commit, which may consist of several Revision objects. A commit means that several files were committed at once by the same author with the same message. TODO: Rename getAuthor() to getLogin(), getAffectedFiles() to getAffectedFileNames() (or change to return CvsFiles?)
Version:
$Id: Commit.java,v 1.16 2008/04/02 11:22:16 benoitx Exp $
Author:
Richard Cyganiak

Constructor Summary

Commit(Revision revision)
Creates a new instance which consists of the given revision.

Method Summary

void
addRevision(Revision revision)
Adds a revision to the commit.
int
compareTo(Object other)
Compares this commit to another revision, based on their date.
Set
getAffectedFiles()
Returns a String Set containing all filenames which were affected by this Commit.
Author
getAuthor()
Returns the author of the commit.
String
getComment()
Returns the comment of the commit.
Date
getDate()
Returns the date when the commit took place.
Set
getRevisions()
Returns the Revision objects that make up this commit.

Constructor Details

Commit

public Commit(Revision revision)
Creates a new instance which consists of the given revision.
Parameters:
revision - the single revision out of which the commit will be created

Method Details

addRevision

public void addRevision(Revision revision)
Adds a revision to the commit. The revision must be part of the commit, that is, it must have the same date, author and message as all other revisions in the commit.
Parameters:
revision - the Revision to add.

compareTo

public int compareTo(Object other)
Compares this commit to another revision, based on their date.

getAffectedFiles

public Set getAffectedFiles()
Returns a String Set containing all filenames which were affected by this Commit.
Returns:
a Set of Strings

getAuthor

public Author getAuthor()
Returns the author of the commit.
Returns:
the author

getComment

public String getComment()
Returns the comment of the commit.
Returns:
the comment

getDate

public Date getDate()
Returns the date when the commit took place. The implementation simply returns the timestamp of the first change of the commit.
Returns:
a date within the timeframe of the commit

getRevisions

public Set getRevisions()
Returns the Revision objects that make up this commit.
Returns:
a set of Revision instances