net.sf.statcvs.model
Class CvsRevision

java.lang.Object
  extended bynet.sf.statcvs.model.CvsRevision
All Implemented Interfaces:
Comparable

public class CvsRevision
extends Object
implements Comparable

One revision of a CvsFile. That can be an initial revision (checkin), a change, a deletion, or a re-add. Revisions are created using the methods CvsFile.addInitialRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int), CvsFile.addChangeRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int, int, int) and CvsFile.addDeletionRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int). TODO: Replace type code with hierarchy TODO: Rename class to Revision, getAuthor() to getLogin(), isDead() to isDeletion()

Version:
$Id: CvsRevision.java,v 1.53 2004/10/12 07:22:42 cyganiak Exp $
Author:
Manuel Schulze, Richard Cyganiak

Field Summary
static int TYPE_BEGIN_OF_LOG
          Marks a revision at the very beginning of the log timespan.
static int TYPE_CHANGE
          Marks a revision that changes the file.
static int TYPE_CREATION
          Marks a revision that creates a new file.
static int TYPE_DELETION
          Marks a revision that deletes the file.
 
Method Summary
 int compareTo(Object other)
          Compares this revision to another revision.
 Author getAuthor()
          Returns the author of this revision.
 String getComment()
          Returns the comment for this revision.
 Date getDate()
          Returns the date of this revision.
 int getEffectiveLinesOfCode()
          Deprecated. Use getLines() instead.
 CvsFile getFile()
          Returns the file which was changed by this revision.
 int getFileCountChange()
          Deprecated. Use getFileCountDelta() instead.
 int getFileCountDelta()
          Returns the change of the file count caused by this revision.
 int getLines()
          Returns the number of lines for this revision.
 int getLinesAdded()
          Deprecated. Use getLinesDelta() and getReplacedLines() instead.
 int getLinesDelta()
          Returns by how many lines the line count changed with this revision.
 int getLinesOfCode()
          Deprecated. Use getLines() instead.
 int getLinesOfCodeChange()
          Deprecated. Use getLinesDelta() instead.
 int getLinesRemoved()
          Deprecated. Use getLinesDelta() and getReplacedLines() instead.
 int getLineValue()
          Deprecated. Use getNewLines() instead.
 int getNewLines()
          Returns the number of "new" lines in this revision.
 CvsRevision getPreviousRevision()
          Returns the predecessor of this revision or null if it is the first revision for the file.
 int getRemovingValue()
          Deprecated. Use getReplacedLines() and getLinesDelta() instead.
 int getReplacedLines()
          Returns the number of lines that were removed and replaced by other lines in this revision.
 String getRevision()
          Deprecated. Use getRevisionNumber() instead.
 String getRevisionNumber()
          Returns the revision number.
 boolean isBeginOfLog()
          Returns true if this is a revision at the very beginning of the log timespan which is only a container for the number of code lines at the beginning of the log and not a real revision committed by an author.
 boolean isDead()
          Returns true if the file is deleted in this revision.
 boolean isInitialRevision()
          Returns true if the file did not exist before this revision and does exist afterwards.
 String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_CREATION

public static final int TYPE_CREATION
Marks a revision that creates a new file. The file did not exist in the current branch before this revision, and it does exist afterwards. Possibly the file existed before, that is, it was deleted and restored.

See Also:
Constant Field Values

TYPE_CHANGE

public static final int TYPE_CHANGE
Marks a revision that changes the file. It does neither create nor delete the file.

See Also:
Constant Field Values

TYPE_DELETION

public static final int TYPE_DELETION
Marks a revision that deletes the file. The file existed before, but does not exist afterwards in the current branch.

See Also:
Constant Field Values

TYPE_BEGIN_OF_LOG

public static final int TYPE_BEGIN_OF_LOG
Marks a revision at the very beginning of the log timespan. This is only a container for the number of code lines at the beginning of the log. It is not a real revision committed by an author.

See Also:
Constant Field Values
Method Detail

getRevisionNumber

public String getRevisionNumber()
Returns the revision number.

Returns:
the revision number

getAuthor

public Author getAuthor()
Returns the author of this revision.

Returns:
the author

getComment

public String getComment()
Returns the comment for this revision.

Returns:
the comment

getDate

public Date getDate()
Returns the date of this revision.

Returns:
the date

getLines

public int getLines()
Returns the number of lines for this revision. This is 0 for dead revisions.

Returns:
the number of lines

getLinesDelta

public int getLinesDelta()
Returns by how many lines the line count changed with this revision. Deletions return -getLines(), re-adds and initial revisions return getLines().

Returns:
the line count change of this revision

getReplacedLines

public int getReplacedLines()
Returns the number of lines that were removed and replaced by other lines in this revision. For example, if 5 lines were added and 2 lines removed, this would be 3. If 1 line was added and 1 was removed, it would be 1. If it was an initial revision or a deletion, it would be 0.

Returns:
the number of lines that were replaced by other lines.

getNewLines

public int getNewLines()
Returns the number of "new" lines in this revision. This is the sum of added and changed lines. In other words, all the "original" lines the author of this revision came up with.

Returns:
lines changed or added

getFileCountDelta

public int getFileCountDelta()
Returns the change of the file count caused by this revision. This is 1 for initial revisions and re-adds, -1 for deletions, and 0 for normal revisions.

Returns:
the file count change of this revision

isInitialRevision

public boolean isInitialRevision()
Returns true if the file did not exist before this revision and does exist afterwards. Possibly the file was deleted before, or it never existed before.

Returns:
true if the file did not exist before

isDead

public boolean isDead()
Returns true if the file is deleted in this revision.

Returns:
true if the file is deleted in this revision

isBeginOfLog

public boolean isBeginOfLog()
Returns true if this is a revision at the very beginning of the log timespan which is only a container for the number of code lines at the beginning of the log and not a real revision committed by an author.

Returns:
true if this revision exists only for StatCvs bookkeeping purposes

toString

public String toString()


getFile

public CvsFile getFile()
Returns the file which was changed by this revision.

Returns:
the file

getPreviousRevision

public CvsRevision getPreviousRevision()
Returns the predecessor of this revision or null if it is the first revision for the file.

Returns:
the predecessor of this revision

compareTo

public int compareTo(Object other)
Compares this revision to another revision. A revision is considered smaller if its date is smaller. If the dates are identical, the filename, author name, revision number and comment will be used to break the tie.

Specified by:
compareTo in interface Comparable

getLinesAdded

public int getLinesAdded()
Deprecated. Use getLinesDelta() and getReplacedLines() instead.


getLinesRemoved

public int getLinesRemoved()
Deprecated. Use getLinesDelta() and getReplacedLines() instead.


getLinesOfCode

public int getLinesOfCode()
Deprecated. Use getLines() instead.


getEffectiveLinesOfCode

public int getEffectiveLinesOfCode()
Deprecated. Use getLines() instead.


getLinesOfCodeChange

public int getLinesOfCodeChange()
Deprecated. Use getLinesDelta() instead.


getLineValue

public int getLineValue()
Deprecated. Use getNewLines() instead.


getRemovingValue

public int getRemovingValue()
Deprecated. Use getReplacedLines() and getLinesDelta() instead.


getFileCountChange

public int getFileCountChange()
Deprecated. Use getFileCountDelta() instead.


getRevision

public String getRevision()
Deprecated. Use getRevisionNumber() instead.