Package org.jenkinsci.plugins.pipeline.github

Class CommitGroovyObject

java.lang.Object

groovy.lang.GroovyObjectSupport

org.jenkinsci.plugins.pipeline.github.CommitGroovyObject

All Implemented Interfaces:

groovy.lang.GroovyObject, Serializable

public class CommitGroovyObject
extends groovy.lang.GroovyObjectSupport
implements Serializable

Groovy wrapper over a RepositoryCommit. Provides useful properties that allow one to iterate over a commits: - Comments - Files - Statuses And a few methods to create: - Review comments - Statuses

Author:

Aaron Whiteside

See Also:

• RepositoryCommit
• Serialized Form

Method Summary

Modifier and Type	Method	Description
ReviewCommentGroovyObject	comment(String body, String path, Integer position)
ReviewCommentGroovyObject	comment(Map<String,Object> params)
CommitStatusGroovyObject	createStatus(String status, String context, String description, String targetUrl)
CommitStatusGroovyObject	createStatus(Map<String,Object> params)
int	getAdditions()
String	getAuthor()
int	getCommentCount()
Iterable<ReviewCommentGroovyObject>	getComments()
String	getCommitter()
int	getDeletions()
Iterable<CommitFileGroovyObject>	getFiles()
String	getMessage()
Iterable<String>	getParents()
String	getSha()
Iterable<CommitStatusGroovyObject>	getStatuses()
int	getTotalChanges()
String	getUrl()

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Methods inherited from class java.lang.Object

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

Method Details

getSha

public String getSha()

getUrl

public String getUrl()

getAuthor

public String getAuthor()

getCommitter

public String getCommitter()

getMessage

public String getMessage()

getCommentCount

public int getCommentCount()

getAdditions

public int getAdditions()

getDeletions

public int getDeletions()

getTotalChanges

public int getTotalChanges()

getComments

public Iterable<ReviewCommentGroovyObject> getComments()

getStatuses

public Iterable<CommitStatusGroovyObject> getStatuses()

getParents

public Iterable<String> getParents()

getFiles

public Iterable<CommitFileGroovyObject> getFiles()

comment

public ReviewCommentGroovyObject comment(Map<String,Object> params)

comment

public ReviewCommentGroovyObject comment(String body,
 String path,
 Integer position)

createStatus

public CommitStatusGroovyObject createStatus(Map<String,Object> params)

createStatus

public CommitStatusGroovyObject createStatus(String status,
 String context,
 String description,
 String targetUrl)