Package net.sf.statcvs.model
Class VersionedFile
java.lang.Object
net.sf.statcvs.model.VersionedFile
- All Implemented Interfaces:
Comparable
Represents one versioned file in the
Repository
,
including its name, Directory
and Revision
list.
Revisions can be created using the addXXXRevision factory
methods. Revisions can be created in any order.
TODO: Rename class to something like VersionedFile, getCurrentLinesOfCode() to getCurrentLines(), maybe getFilenameXXX, isDead() to isDeleted()- Version:
- $Id: VersionedFile.java,v 1.5 2009/08/31 19:16:35 benoitx Exp $
- Author:
- Manuel Schulze, Richard Cyganiak <richard@cyganiak.de>
-
Constructor Summary
ConstructorsConstructorDescriptionVersionedFile
(String name, Directory directory) Creates a VersionedFile object. -
Method Summary
Modifier and TypeMethodDescriptionaddBeginOfLogRevision
(Date date, int lines, SortedSet symbolicNames) Adds a "begin of log" revision to the file.addChangeRevision
(String revisionNumber, Author author, Date date, String comment, int lines, int linesDelta, int replacedLines, SortedSet symbolicNames) Adds a change revision to the file.addDeletionRevision
(String revisionNumber, Author author, Date date, String comment, int lines, SortedSet symbolicNames) Adds a deletion revision to the file.addInitialRevision
(String revisionNumber, Author author, Date date, String comment, int lines, SortedSet symbolicNames) Adds an initial revision to the file.int
Compares this file to another one, based on filename.boolean
Returns a list of authors that have commited at least one revision of the file.int
Returns the current number of lines for this file.Returns the file's Directory.Returns the filename without path.Returns the full filename.Gets the earliest revision of this file.Gets the latest revision of this file.getPreviousRevision
(Revision revision) Returns the revision which was replaced by the revision given as argument.Returns the list ofRevision
s of this file, sorted from earliest to most recent.boolean
Returns true, ifauthor
worked on this file.int
hashCode()
boolean
isDead()
Returnstrue
if the latest revision of this file was a deletion.void
toString()
-
Constructor Details
-
VersionedFile
Creates a VersionedFile object.- Parameters:
name
- The full name of the filedirectory
- the directory where the file resides
-
-
Method Details
-
getAuthors
Returns a list of authors that have commited at least one revision of the file.- Returns:
- a list of authors
-
getFilenameWithPath
Returns the full filename.- Returns:
- the full filename
-
getFilename
Returns the filename without path.- Returns:
- the filename without path
-
getDirectory
Returns the file's Directory.- Returns:
- the file's Directory
-
getLatestRevision
Gets the latest revision of this file.- Returns:
- the latest revision of this file
-
getInitialRevision
Gets the earliest revision of this file.- Returns:
- the earliest revision of this file
-
getRevisions
Returns the list ofRevision
s of this file, sorted from earliest to most recent.- Returns:
- a SortedSet of
Revision
s
-
getCurrentLinesOfCode
public int getCurrentLinesOfCode()Returns the current number of lines for this file. Binary files and deleted files are assumed to have 0 lines.- Returns:
- the current number of lines for this file
-
isDead
public boolean isDead()Returnstrue
if the latest revision of this file was a deletion.- Returns:
true
if this file is deleted
-
hasAuthor
Returns true, ifauthor
worked on this file.- Parameters:
author
- TheAuthor
to search for- Returns:
true
, if the author is listed in one of this file's revisions
-
getPreviousRevision
Returns the revision which was replaced by the revision given as argument. Returns null if the given revision is the initial revision of this file.- Parameters:
revision
- a revision of this file- Returns:
- this revision's predecessor
-
toString
-
compareTo
Compares this file to another one, based on filename.- Specified by:
compareTo
in interfaceComparable
- See Also:
-
equals
-
hashCode
public int hashCode() -
addInitialRevision
public Revision addInitialRevision(String revisionNumber, Author author, Date date, String comment, int lines, SortedSet symbolicNames) Adds an initial revision to the file. An initial revision is either the first revision of the file, or a re-add after the file was deleted.- Parameters:
revisionNumber
- the revision number, for example "1.1"author
- the login from which the change was committeddate
- the time when the change was committedcomment
- the commit messagelines
- the number of lines of the new file
-
addChangeRevision
public Revision addChangeRevision(String revisionNumber, Author author, Date date, String comment, int lines, int linesDelta, int replacedLines, SortedSet symbolicNames) Adds a change revision to the file.- Parameters:
revisionNumber
- the revision number, for example "1.1"author
- the login from which the change was committeddate
- the time when the change was committedcomment
- the commit messagelines
- the number of lines in the file after the changelinesDelta
- the change in the number of linesreplacedLines
- number of lines that were removed and replaced by others
-
addDeletionRevision
public Revision addDeletionRevision(String revisionNumber, Author author, Date date, String comment, int lines, SortedSet symbolicNames) Adds a deletion revision to the file.- Parameters:
revisionNumber
- the revision number, for example "1.1"author
- the login from which the change was committeddate
- the time when the change was committedcomment
- the commit messagelines
- the number of lines in the file before it was deleted
-
addBeginOfLogRevision
Adds a "begin of log" revision to the file. This kind of revision only marks the beginning of the log timespan if the file was already present in the repository at this time. It is not an actual revision committed by an author.- Parameters:
date
- the begin of the loglines
- the number of lines in the file at that time
-
getModule
-
setModule
-