io.jenkins.plugins.forensics.miner

Class RepositoryStatistics

java.lang.Object

io.jenkins.plugins.forensics.miner.RepositoryStatistics

public class RepositoryStatistics
extends Object

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

Constructor Summary

Constructors

Constructor and Description
RepositoryStatistics()

Method Summary

Modifier and Type	Method and Description
void	addAll(Collection<FileStatistics> 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.
List<String>	getErrorMessages()
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.
List<String>	getInfoMessages()
boolean	isEmpty() Returns whether the repository is empty.
void	logError(String format, Object... args) Logs the specified error message.
void	logException(Exception exception, String format, Object... args) Logs the specified exception.
void	logInfo(String format, Object... args) Logs the specified information message.
void	logSummary() Writes a summary message to the reports' error log that denotes the total number of errors that have been reported.
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

logInfo

@FormatMethod
public void logInfo(String format,
                                  Object... args)

Logs the specified information message. Use this method to log any useful information when composing this log.

Parameters:

format - A format string

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

logError

@FormatMethod
public void logError(String format,
                                   Object... args)

Logs the specified error message. Use this method to log any error when composing this log.

Parameters:

format - A format string

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

logException

@FormatMethod
public void logException(Exception exception,
                                       String format,
                                       Object... args)

Logs the specified exception. Use this method to log any exception when composing this log.

Parameters:

exception - the exception to log

format - A format string

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

logSummary

public void logSummary()

Writes a summary message to the reports' error log that denotes the total number of errors that have been reported.

getErrorMessages

public List<String> getErrorMessages()

getInfoMessages

public List<String> getInfoMessages()

addAll

public void addAll(Collection<FileStatistics> statistics)