org.kohsuke.github

Class GHCompare

java.lang.Object

org.kohsuke.github.GHCompare

public class GHCompare
extends Object

The model user for comparing 2 commits in the GitHub API.

Author:

Michael Clarke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHCompare.Commit Compare commits had a child commit element with additional details we want to capture.
static class	GHCompare.InnerCommit
static class	GHCompare.Status
static class	GHCompare.Tree
static class	GHCompare.User Deprecated. use GitUser instead.

Field Summary

Fields

Modifier and Type	Field and Description
GHCompare.Status	status

Constructor Summary

Constructors

Constructor and Description
GHCompare()

Method Summary

Methods

Modifier and Type	Method and Description
int	getAheadBy()
GHCompare.Commit	getBaseCommit()
int	getBehindBy()
GHCompare.Commit[]	getCommits() Gets an array of commits.
URL	getDiffUrl()
GHCommit.File[]	getFiles() Gets an array of commits.
URL	getHtmlUrl()
GHCompare.Commit	getMergeBaseCommit()
URL	getPatchUrl()
URL	getPermalinkUrl()
GHCompare.Status	getStatus()
int	getTotalCommits()
URL	getUrl()
GHCompare	wrap(GHRepository owner)

Methods inherited from class java.lang.Object

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

Field Detail

status

public GHCompare.Status status

Constructor Detail

GHCompare

public GHCompare()

Method Detail

getUrl

public URL getUrl()

getHtmlUrl

public URL getHtmlUrl()

getPermalinkUrl

public URL getPermalinkUrl()

getDiffUrl

public URL getDiffUrl()

getPatchUrl

public URL getPatchUrl()

getStatus

public GHCompare.Status getStatus()

getAheadBy

public int getAheadBy()

getBehindBy

public int getBehindBy()

getTotalCommits

public int getTotalCommits()

getBaseCommit

public GHCompare.Commit getBaseCommit()

getMergeBaseCommit

public GHCompare.Commit getMergeBaseCommit()

getCommits

public GHCompare.Commit[] getCommits()

Gets an array of commits.

Returns:

A copy of the array being stored in the class.

getFiles

public GHCommit.File[] getFiles()

Gets an array of commits.

Returns:

A copy of the array being stored in the class.

wrap

public GHCompare wrap(GHRepository owner)