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 statistics of all repository files. Additionally, info and error messages during the SCM processing will be stored.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RepositoryStatistics()

Method Summary

Modifier and Type	Method and Description
void	add(FileStatistics additionalStatistics) Adds the additional file statistics instance.
void	addAll(Collection<FileStatistics> additionalStatistics) Adds all additional file statistics.
void	addAll(RepositoryStatistics additionalStatistics) Adds all additional file statistics.
boolean	contains(String fileName) Returns whether the specified file is part of the repository.
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.
boolean	isEmpty() Returns whether the repository is empty.
int	size() Returns the number of files in the repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryStatistics

public RepositoryStatistics()

Method Detail

isEmpty

public boolean isEmpty()

Returns whether the repository is empty.

Returns:

true if the repository is empty, 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 requests

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(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