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 file to all affected lines in that file.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileLocations() Creates an empty instance of FileLocations.
FileLocations(String workspace) Creates an empty instance of FileLocations that will work on the specified workspace.

Method Summary

Modifier and Type	Method and Description
void	addLine(String fileName, int lineStart) Adds a blame request for the specified affected file and line number.
boolean	contains(String fileName) Returns whether the specified file already has been added.
Set<Integer>	get(String fileName) Returns the blames for the specified file.
Set<String>	getFiles() Returns the absolute file names of the affected files that will be processed by Git blame.
Set<String>	getSkippedFiles()
boolean	isEmpty() Returns whether there are files with blames in this instance.
int	size() Returns the number of files that have been added to this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLocations

public FileLocations()

Creates an empty instance of FileLocations.

FileLocations

public FileLocations(String workspace)

Creates an empty instance of FileLocations that will work on the specified workspace.

Parameters:

workspace - the workspace to get the Git repository from

Method Detail

isEmpty

public boolean isEmpty()

Returns whether there are files with blames in this instance.

Returns:

true if there a no blames available, false otherwise

size

public int size()

Returns the number of files that have been added to this instance.

Returns:

number of affected files with blames

contains

public boolean contains(String fileName)

Returns whether the specified file already has been added.

Parameters:

fileName - the name of the file

Returns:

true if the file already has been added, false otherwise

getSkippedFiles

public Set<String> getSkippedFiles()

addLine

public void addLine(String fileName,
                    int lineStart)

Adds a blame request for the specified affected file and line number. This file and line will be processed by Git blame later on.

Parameters:

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

lineStart - the line number to find the blame for

getFiles

public Set<String> getFiles()

Returns the absolute file names of the affected files that will be processed by Git blame.

Returns:

the file names

get

public Set<Integer> get(String fileName)

Returns the blames for the specified file.

Parameters:

fileName - absolute file name

Returns:

the blames for that file

Throws:

NoSuchElementException - if the file name is not registered