io.jenkins.plugins.forensics.blame

Class Blames

java.lang.Object

io.jenkins.plugins.forensics.blame.Blames

All Implemented Interfaces:

Serializable

public class Blames
extends Object
implements Serializable

Provides access to the blame information for a collection of workspace files. File names must use absolute paths. Additionally, info and error messages during the SCM processing can be stored.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Blames()

Method Summary

Modifier and Type	Method and Description
void	add(FileBlame additionalBlame) Adds the specified blame to this collection of blames.
void	addAll(Blames other) Merges all specified blames with the current collection of blames.
boolean	contains(String fileName) Returns whether there are blames for the specified file.
FileBlame	getBlame(String fileName) Returns the blame information for the specified file.
List<String>	getErrorMessages()
Set<String>	getFiles() Returns all files with blames.
List<String>	getInfoMessages()
boolean	isEmpty() Returns whether there are files with blames.
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.
protected Object	readResolve() Called after de-serialization to retain backward compatibility.
int	size() Returns the number of files with blames.

Methods inherited from class java.lang.Object

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

Constructor Detail

Blames

public Blames()

Method Detail

add

public void add(FileBlame additionalBlame)

Adds the specified blame to this collection of blames.

Parameters:

additionalBlame - the blame to add

addAll

public void addAll(Blames other)

Merges all specified blames with the current collection of blames.

Parameters:

other - the blames to add

isEmpty

public boolean isEmpty()

Returns whether there are files with blames.

Returns:

true if there a no blames available, false otherwise

size

public int size()

Returns the number of files with blames.

Returns:

number of affected files with blames

contains

public boolean contains(String fileName)

Returns whether there are blames for the specified file.

Parameters:

fileName - the relative or absolute path of the file

Returns:

true if the file already has been added, false otherwise

getFiles

public Set<String> getFiles()

Returns all files with blames.

Returns:

the files with blames

getBlame

public FileBlame getBlame(String fileName)

Returns the blame information for the specified file.

Parameters:

fileName - the absolute path of the file

Returns:

the blame information for the specified 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()

readResolve

protected Object readResolve()

Called after de-serialization to retain backward compatibility.

Returns:

this