io.jenkins.plugins.forensics.blame

Class FileLocations

java.lang.Object

io.jenkins.plugins.forensics.blame.FileLocations

All Implemented Interfaces:

Serializable

public class FileLocations
extends Object
implements Serializable

Defines a set of file locations. A file location is identified by the file name (relative to the workspace location) and line number. File locations are grouped by file name, i.e. you can obtain a mapping of a file to all affected lines in that file.

Author:

Ullrich Hafner

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileLocations.FileSystem File system facade for test cases.

Constructor Summary

Constructors

Constructor and Description
FileLocations()

Method Summary

Modifier and Type	Method and Description
void	addLine(String fileName, int lineStart) Adds the specified affected file and line number.
boolean	contains(String fileName) Returns whether the specified file has been added.
Set<String>	getAbsolutePaths() Returns the absolute file names of all files.
List<String>	getErrorMessages()
List<String>	getInfoMessages()
Set<Integer>	getLines(String fileName) Returns the added lines for the specified file.
Set<String>	getRelativePaths() Returns the relative file names of all files.
Set<String>	getSkippedFiles()
String	getWorkspace()
boolean	isEmpty() Returns whether some files have been added.
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.
void	setFileSystem(FileLocations.FileSystem fileSystem)
void	setWorkspace(File workspace) Sets the Git workspace for all files that will be added later on.
void	setWorkspace(String workspace) Sets the Git workspace for all files that will be added later on.
int	size() Returns the number of files that have been added.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLocations

public FileLocations()

Method Detail

setWorkspace

public void setWorkspace(File workspace)

Sets the Git workspace for all files that will be added later on.

Parameters:

workspace - the workspace to get the Git repository from

setWorkspace

public void setWorkspace(String workspace)

Sets the Git workspace for all files that will be added later on.

Parameters:

workspace - the workspace to get the Git repository from

getWorkspace

public String getWorkspace()

setFileSystem

public void setFileSystem(FileLocations.FileSystem fileSystem)

getSkippedFiles

public Set<String> getSkippedFiles()

addLine

public void addLine(String fileName,
                    int lineStart)

Adds the specified affected file and line number. This file and line will be processed by Git blame later on. Only files that are part of the workspace will be processed.

Parameters:

fileName - the absolute file name that will be used as a key

lineStart - the line number to find the blame for

isEmpty

public boolean isEmpty()

Returns whether some files have been added.

Returns:

true if there a no blames available, false otherwise

size

public int size()

Returns the number of files that have been added.

Returns:

number of affected files with blames

contains

public boolean contains(String fileName)

Returns whether the specified file has been added.

Parameters:

fileName - the relative or absolute path of the file

Returns:

true if the file already has been added, false otherwise

getRelativePaths

public Set<String> getRelativePaths()

Returns the relative file names of all files.

Returns:

the relative file names

getAbsolutePaths

public Set<String> getAbsolutePaths()

Returns the absolute file names of all files.

Returns:

the absolute file names

getLines

public Set<Integer> getLines(String fileName)

Returns the added lines for the specified file.

Parameters:

fileName - the relative or absolute path of the file

Returns:

the lines 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()