public class Revision
extends java.lang.Object
implements java.lang.Comparable
VersionedFile
. That can be an initial revision
(checkin), a change, a deletion, or a re-add. Revisions are created
using the methods VersionedFile.addInitialRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int, java.util.SortedSet)
,
VersionedFile.addChangeRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int, int, int, java.util.SortedSet)
and
VersionedFile.addDeletionRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int, java.util.SortedSet)
.
TODO: Replace type code with hierarchy
TODO: Rename class to Revision, getAuthor() to getLogin(), isDead() to isDeletion()Modifier and Type | Field and Description |
---|---|
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.
|
Constructor and Description |
---|
Revision(VersionedFile file,
java.lang.String revisionNumber,
int type,
Author author,
java.util.Date date,
java.lang.String comment,
int lines,
int linesDelta,
int linesReplaced,
java.util.SortedSet symbolicNames)
Creates a new revision of a file with the
specified revision number.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(java.lang.Object other)
Compares this revision to another revision.
|
boolean |
equals(java.lang.Object rhs) |
Author |
getAuthor()
Returns the author of this revision.
|
java.lang.String |
getComment()
Returns the comment for this revision.
|
java.util.Date |
getDate()
Returns the date of this revision.
|
int |
getEffectiveLinesOfCode()
Deprecated.
Use
getLines() instead. |
VersionedFile |
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.
|
Revision |
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.
|
java.lang.String |
getRevision()
Deprecated.
Use
getRevisionNumber() instead. |
java.lang.String |
getRevisionNumber()
Returns the revision number.
|
java.util.SortedSet |
getSymbolicNames()
Returns a list of
SymbolicName s of this revision or null if
the revision has no symbolic names. |
int |
hashCode() |
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. |
java.lang.String |
toString() |
public static final int TYPE_CREATION
public static final int TYPE_CHANGE
public static final int TYPE_DELETION
public static final int TYPE_BEGIN_OF_LOG
public Revision(VersionedFile file, java.lang.String revisionNumber, int type, Author author, java.util.Date date, java.lang.String comment, int lines, int linesDelta, int linesReplaced, java.util.SortedSet symbolicNames)
VersionedFile.addInitialRevision(java.lang.String, net.sf.statcvs.model.Author, java.util.Date, java.lang.String, int, java.util.SortedSet)
and its sister methods should
be used.file
- VersionedFile that belongs to this revisionrevisionNumber
- revision number, for example "1.1"type
- a TYPE_XXX constantauthor
- the author of the revisiondate
- the date of the revisioncomment
- the author's commentlines
- number of lines; 0 for deletionslinesDelta
- by how much did the number of lines change, compared to the previous revision?linesReplaced
- How many lines were removed and replaced by other lines, without the delta changing?symbolicNames
- list of symbolic names for this revision or null if this revision has no symbolic namespublic java.lang.String getRevisionNumber()
public Author getAuthor()
public java.lang.String getComment()
public java.util.Date getDate()
public int getLines()
public int getLinesDelta()
-getLines()
,
re-adds and initial revisions return getLines()
.public int getReplacedLines()
public int getNewLines()
public int getFileCountDelta()
public boolean isInitialRevision()
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.true
if the file did not exist beforepublic boolean isDead()
true
if the file is deleted in this revisionpublic boolean isBeginOfLog()
true
if this revision exists
only for StatCvs bookkeeping purposespublic java.lang.String toString()
toString
in class java.lang.Object
public VersionedFile getFile()
public Revision getPreviousRevision()
public java.util.SortedSet getSymbolicNames()
SymbolicName
s of this revision or null if
the revision has no symbolic names. The list is ordered from
latest to oldest.public int compareTo(java.lang.Object other)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object rhs)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int getLinesAdded()
getLinesDelta()
and getReplacedLines()
instead.public int getLinesRemoved()
getLinesDelta()
and getReplacedLines()
instead.public int getLinesOfCode()
getLines()
instead.public int getEffectiveLinesOfCode()
getLines()
instead.public int getLinesOfCodeChange()
getLinesDelta()
instead.public int getLineValue()
getNewLines()
instead.public int getRemovingValue()
getReplacedLines()
and getLinesDelta()
instead.public int getFileCountChange()
getFileCountDelta()
instead.public java.lang.String getRevision()
getRevisionNumber()
instead.