Package io.jenkins.plugins.forensics.miner

Class RepositoryStatistics

java.lang.Object

io.jenkins.plugins.forensics.miner.RepositoryStatistics

All Implemented Interfaces:

Serializable

public class RepositoryStatistics
extends Object
implements Serializable

Provides access to the SCM commit statistics of all repository files up to a specific commit.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RepositoryStatistics()	Creates an empty instance of RepositoryStatistics with no latest commit ID set.
RepositoryStatistics(String latestCommitId)	Creates an empty instance of RepositoryStatistics.

Method Summary

Modifier and Type	Method	Description
void	add(FileStatistics additionalStatistics)	Adds the additional file statistics instance.
void	addAll(RepositoryStatistics additionalStatistics)	Adds all additional file statistics.
void	addAll(Collection<FileStatistics> additionalStatistics)	Adds all additional file statistics.
void	addAll(List<CommitDiffItem> commits)	Adds and inspects the specified commits.
boolean	contains(String fileName)	Returns whether the specified file is part of the repository.
boolean	equals(Object o)
FileStatistics	get(String fileName)	Returns the statistics for the specified file.
Set<String>	getFiles()	Returns the absolute file names of the files that are part of the repository.
Collection<FileStatistics>	getFileStatistics()	Returns the statistics for all repository files.
String	getLatestCommitId()	Returns the ID of the latest commit mined.
CommitStatistics	getLatestStatistics()
Map<String,FileStatistics>	getMapping()	Returns the mapping of file names to statistics.
int	getTotalChurn()
int	getTotalLinesOfCode()
int	hashCode()
boolean	hasLatestCommitId()	Returns whether the latest commit ID has been set.
boolean	isEmpty()	Returns whether the repository is empty.
protected Object	readResolve()	Called after deserialization to retain backward compatibility.
int	size()	Returns the number of files in the repository.
protected Object	writeReplace()	Called before serialization to fill the fileStatistics field.

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryStatistics

public RepositoryStatistics()

Creates an empty instance of RepositoryStatistics with no latest commit ID set.

RepositoryStatistics

public RepositoryStatistics(String latestCommitId)

Creates an empty instance of RepositoryStatistics.

Parameters:

latestCommitId - the ID of the latest commit that

Method Details

readResolve

protected Object readResolve()

Called after deserialization to retain backward compatibility.

Returns:

this

writeReplace

protected Object writeReplace()

Called before serialization to fill the fileStatistics field.

Returns:

this

isEmpty

public boolean isEmpty()

Returns whether the repository is empty.

Returns:

true if the repository is empty, false otherwise

getLatestCommitId

public String getLatestCommitId()

Returns the ID of the latest commit mined.

Returns:

ID of the latest commit.

hasLatestCommitId

public boolean hasLatestCommitId()

Returns whether the latest commit ID has been set.

Returns:

true if the latest commit ID has been set, false otherwise

size

public int size()

Returns the number of files in the repository.

Returns:

number of files in the repository

contains

public boolean contains(String fileName)

Returns whether the specified file is part of the repository.

Parameters:

fileName - the name of the file

Returns:

true if the file file is part of the repository, false otherwise

getFiles

public Set<String> getFiles()

Returns the absolute file names of the files that are part of the repository.

Returns:

the file names

getFileStatistics

public Collection<FileStatistics> getFileStatistics()

Returns the statistics for all repository files.

Returns:

the statistics

getMapping

public Map<String,FileStatistics> getMapping()

Returns the mapping of file names to statistics.

Returns:

the mapping of file names to statistics

get

public FileStatistics get(String fileName)

Returns the statistics for the specified file.

Parameters:

fileName - absolute file name

Returns:

the statistics for that file

Throws:

NoSuchElementException - if the file name is not registered

addAll

public void addAll(List<CommitDiffItem> commits)

Adds and inspects the specified commits.

Parameters:

commits - the additional commits

addAll

public void addAll(Collection<FileStatistics> additionalStatistics)

Adds all additional file statistics.

Parameters:

additionalStatistics - the additional statistics to add

addAll

public void addAll(RepositoryStatistics additionalStatistics)

Adds all additional file statistics.

Parameters:

additionalStatistics - the additional statistics to add

add

public void add(FileStatistics additionalStatistics)

Adds the additional file statistics instance.

Parameters:

additionalStatistics - the additional statistics to add

getTotalChurn

public int getTotalChurn()

getTotalLinesOfCode

public int getTotalLinesOfCode()

getLatestStatistics

public CommitStatistics getLatestStatistics()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object