io.jenkins.plugins.forensics.git.reference

Class GitCommitsRecord

java.lang.Object

io.jenkins.plugins.forensics.git.reference.GitCommitsRecord

All Implemented Interfaces:

Action, ModelObject, Serializable, RunAction2

public class GitCommitsRecord
extends Object
implements RunAction2, Serializable

Stores all commits for a given build and provides a link to the latest commit. For each SCM repository a unique GitCommitsRecord instance will be used.

Author:

Arne Schöntag

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
List<String>	getCommits()
String	getDisplayName()
List<String>	getErrorMessages()
String	getIconFileName()
List<String>	getInfoMessages()
String	getLatestCommit()
String	getLatestCommitLink()
Run<?,?>	getOwner()
Optional<Run<?,?>>	getReferencePoint(GitCommitsRecord referenceCommits, int maxCommits, boolean skipUnknownCommits) Tries to find a reference build using the specified GitCommitsRecord of the reference job as a starting point.
String	getScmKey()
int	getSize()
String	getUrlName()
boolean	isEmpty()
boolean	isFirstBuild()
boolean	isNotEmpty()
void	onAttached(Run<?,?> run)
void	onLoad(Run<?,?> run)
int	size() Returns the number of new commits.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getOwner

public Run<?,?> getOwner()

isFirstBuild

public boolean isFirstBuild()

getScmKey

public String getScmKey()

getLatestCommit

public String getLatestCommit()

getLatestCommitLink

public String getLatestCommitLink()

getErrorMessages

public List<String> getErrorMessages()

getInfoMessages

public List<String> getInfoMessages()

size

public int size()

Returns the number of new commits.

Returns:

the number of new commits

getSize

public int getSize()

isNotEmpty

public boolean isNotEmpty()

isEmpty

public boolean isEmpty()

getCommits

public List<String> getCommits()

onAttached

public void onAttached(Run<?,?> run)

Specified by:

onAttached in interface RunAction2

onLoad

public void onLoad(Run<?,?> run)

Specified by:

onLoad in interface RunAction2

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

toString

public String toString()

Overrides:

toString in class Object

getReferencePoint

public Optional<Run<?,?>> getReferencePoint(GitCommitsRecord referenceCommits,
                                            int maxCommits,
                                            boolean skipUnknownCommits)

Tries to find a reference build using the specified GitCommitsRecord of the reference job as a starting point.

Parameters:

referenceCommits - the recorded commits of the build of the reference job that should be used as a starting point for the search

maxCommits - maximal number of commits to look at

skipUnknownCommits - determines whether a build with unknown commits should be skipped or not

Returns:

the found reference build or empty if none has been found