io.jenkins.plugins.forensics.miner

Class FileStatistics

java.lang.Object

io.jenkins.plugins.forensics.miner.FileStatistics

All Implemented Interfaces:

Serializable

public class FileStatistics
extends Object
implements Serializable

Aggregates commit statistics for a given file. The following statistics are summed up:

• total number of commits
• total number of different authors
• creation time
• last modification time

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileStatistics(String fileName) Creates a new instance of FileStatistics.
FileStatistics(String fileName, int today) Creates a new instance of FileStatistics.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getAgeInDays() Returns the age of this file.
int	getCreationTime() Returns the creation time of this file.
String	getFileName()
int	getLastModificationTime() Returns the time of the last modification of this file (i.e. last commit to the file).
int	getLastModifiedInDays() Returns the last modification time of this file.
int	getNumberOfAuthors()
int	getNumberOfCommits()
int	hashCode()
void	inspectCommit(int commitTime, String author) Inspects the next commit for this file.
protected Object	readResolve() Called after de-serialization to retain backward compatibility.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileStatistics

public FileStatistics(String fileName)

Creates a new instance of FileStatistics.

Parameters:

fileName - the name of the file for which statistics will be generated

FileStatistics

public FileStatistics(String fileName,
                      int today)

Creates a new instance of FileStatistics.

Parameters:

fileName - the name of the file for which statistics will be generated

today - today (given as number of seconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.).

Method Detail

getFileName

public String getFileName()

readResolve

protected Object readResolve()

Called after de-serialization to retain backward compatibility.

Returns:

this

getNumberOfAuthors

public int getNumberOfAuthors()

getNumberOfCommits

public int getNumberOfCommits()

getCreationTime

public int getCreationTime()

Returns the creation time of this file.

Returns:

the time of the creation (given as number of seconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.).

getLastModificationTime

public int getLastModificationTime()

Returns the time of the last modification of this file (i.e. last commit to the file).

Returns:

the time of the last modification (given as number of seconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.).

getAgeInDays

public int getAgeInDays()

Returns the age of this file. It is given as the number of days starting from today. If the file has been created today, then 0 is returned.

Returns:

the age in days (from now)

getLastModifiedInDays

public int getLastModifiedInDays()

Returns the last modification time of this file. It is given as the number of days starting from today. If the file has been modified today, then 0 is returned.

Returns:

the age in days (from now)

inspectCommit

public void inspectCommit(int commitTime,
                          String author)

Inspects the next commit for this file. The commits should be inspected in a sorted way, i.e. starting with the newest commit until the first commit has been reached.

Parameters:

commitTime - the time of the commit (given as number of seconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.).

author - author (or committer) name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object