Package io.jenkins.updatebot.commands

Class CommandContext

java.lang.Object

io.jenkins.updatebot.commands.CommandContext

Direct Known Subclasses:

EnableFabric8Context, PromoteContext, PushRegexChangesContext, PushSourceChangesContext, PushVersionChangesContext

public class CommandContext
extends Object

Constructor Summary

Constructors

Constructor	Description
CommandContext(CommandContext parentContext)
CommandContext(LocalRepository repository, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected void	addChild(CommandContext child)
String	createCommit()
String	createIssueTitlePrefix()
String	createPullRequestBody()
String	createPullRequestTitle()
String	createPullRequestTitlePrefix()
StatusInfo	createStatusInfo()
void	error(org.slf4j.Logger log, String message)
void	error(org.slf4j.Logger log, String message, Throwable e)
File	file(String relativePath)	Returns the relative file path within the local repo
protected CommandContext	firstChild()
List<CommandContext>	getChildren()
String	getCloneUrl()
Configuration	getConfiguration()
File	getDir()
GitPlugin	getGit()
org.kohsuke.github.GHIssue	getIssue()
CommandContext	getParentContext()
org.kohsuke.github.GHPullRequest	getPullRequest()
LocalRepository	getRepository()
String	getRepositoryFullName()
Status	getStatus()
Set<File>	getUpdatedFiles()
org.kohsuke.github.GHRepository	gitHubRepository()	Returns the underlying github repository or null if its not a github repo
void	info(org.slf4j.Logger log, String message)
boolean	isUpdated()	Returns true if one or more files have been updated
void	removeChild(CommandContext child)	Lets remove a child context if it wasn't applicable (to avoid generating unnecessary change comments etc
void	setIssue(org.kohsuke.github.GHIssue issue)
void	setPullRequest(org.kohsuke.github.GHPullRequest pullRequest)
void	setStatus(Status status)
void	updatedFile(File file)
PushVersionChangesContext	updateVersion(Kind kind, String name, String version)
void	warn(org.slf4j.Logger log, String message)
void	warn(org.slf4j.Logger log, String message, Throwable e)

Methods inherited from class java.lang.Object

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

Constructor Details

CommandContext

public CommandContext(LocalRepository repository,
Configuration configuration)

CommandContext

public CommandContext(CommandContext parentContext)

Method Details

getConfiguration

public Configuration getConfiguration()

getParentContext

public CommandContext getParentContext()

getChildren

public List<CommandContext> getChildren()

getRepository

public LocalRepository getRepository()

getIssue

public org.kohsuke.github.GHIssue getIssue()

setIssue

public void setIssue(org.kohsuke.github.GHIssue issue)

getPullRequest

public org.kohsuke.github.GHPullRequest getPullRequest()

setPullRequest

public void setPullRequest(org.kohsuke.github.GHPullRequest pullRequest)

getRepositoryFullName

public String getRepositoryFullName()

getStatus

public Status getStatus()

setStatus

public void setStatus(Status status)

isUpdated

public boolean isUpdated()

Returns true if one or more files have been updated

getUpdatedFiles

public Set<File> getUpdatedFiles()

getCloneUrl

public String getCloneUrl()

getDir

public File getDir()

gitHubRepository

public org.kohsuke.github.GHRepository gitHubRepository()

Returns the underlying github repository or null if its not a github repo

file

public File file(String relativePath)

Returns the relative file path within the local repo

updatedFile

public void updatedFile(File file)

getGit

public GitPlugin getGit()

updateVersion

public PushVersionChangesContext updateVersion(Kind kind,
String name,
String version)

createPullRequestTitle

public String createPullRequestTitle()

createIssueTitlePrefix

public String createIssueTitlePrefix()

createPullRequestTitlePrefix

public String createPullRequestTitlePrefix()

createCommit

public String createCommit()

createPullRequestBody

public String createPullRequestBody()

addChild

protected void addChild(CommandContext child)

removeChild

public void removeChild(CommandContext child)

Lets remove a child context if it wasn't applicable (to avoid generating unnecessary change comments etc

firstChild

protected CommandContext firstChild()

createStatusInfo

public StatusInfo createStatusInfo()

info

public void info(org.slf4j.Logger log,
String message)

warn

public void warn(org.slf4j.Logger log,
String message)

warn

public void warn(org.slf4j.Logger log,
String message,
Throwable e)

error

public void error(org.slf4j.Logger log,
String message)

error

public void error(org.slf4j.Logger log,
String message,
Throwable e)