Package org.kohsuke.github

Class GHRepositoryStatistics

java.lang.Object

org.kohsuke.github.GHRepositoryStatistics

public class GHRepositoryStatistics
extends Object

Statistics for a GitHub repository.

Author:

Martin van Zijl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHRepositoryStatistics.CodeFrequency	The type CodeFrequency.
static class	GHRepositoryStatistics.CommitActivity	The type CommitActivity.
static class	GHRepositoryStatistics.ContributorStats	The type ContributorStats.
static class	GHRepositoryStatistics.Participation	The type Participation.
static class	GHRepositoryStatistics.PunchCardItem	The type PunchCardItem.

Constructor Summary

Constructors

Constructor	Description
GHRepositoryStatistics(GHRepository repo)	Instantiates a new Gh repository statistics.

Method Summary

Modifier and Type	Method	Description
List<GHRepositoryStatistics.CodeFrequency>	getCodeFrequency()	Get the number of additions and deletions per week.
PagedIterable<GHRepositoryStatistics.CommitActivity>	getCommitActivity()	Get the last year of commit activity data.
PagedIterable<GHRepositoryStatistics.ContributorStats>	getContributorStats()	Get contributors list with additions, deletions, and commit count.
PagedIterable<GHRepositoryStatistics.ContributorStats>	getContributorStats(boolean waitTillReady)	Gets contributor stats.
GHRepositoryStatistics.Participation	getParticipation()	Get the weekly commit count for the repository owner and everyone else.
List<GHRepositoryStatistics.PunchCardItem>	getPunchCard()	Get the number of commits per hour in each day.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Methods inherited from class java.lang.Object

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

Constructor Details

GHRepositoryStatistics

public GHRepositoryStatistics(GHRepository repo)

Instantiates a new Gh repository statistics.

Parameters:

repo - the repo

Method Details

getContributorStats

public PagedIterable<GHRepositoryStatistics.ContributorStats> getContributorStats()
                                                                           throws IOException,
InterruptedException

Get contributors list with additions, deletions, and commit count. See https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts

Returns:

the contributor stats

Throws:

IOException - the io exception

InterruptedException - the interrupted exception

getContributorStats

@BetaApi
public PagedIterable<GHRepositoryStatistics.ContributorStats> getContributorStats(boolean waitTillReady)
                                                                           throws IOException,
InterruptedException

Gets contributor stats.

Parameters:

waitTillReady - Whether to sleep the thread if necessary until the statistics are ready. This is true by default.

Returns:

the contributor stats

Throws:

IOException - the io exception

InterruptedException - the interrupted exception

getCommitActivity

public PagedIterable<GHRepositoryStatistics.CommitActivity> getCommitActivity()
                                                                       throws IOException

Get the last year of commit activity data. See https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data

Returns:

the commit activity

Throws:

IOException - the io exception

getCodeFrequency

public List<GHRepositoryStatistics.CodeFrequency> getCodeFrequency()
                                                            throws IOException

Get the number of additions and deletions per week. See https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week

Returns:

the code frequency

Throws:

IOException - the io exception

getParticipation

public GHRepositoryStatistics.Participation getParticipation()
                                                      throws IOException

Get the weekly commit count for the repository owner and everyone else. See https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else

Returns:

the participation

Throws:

IOException - the io exception

getPunchCard

public List<GHRepositoryStatistics.PunchCardItem> getPunchCard()
                                                        throws IOException

Get the number of commits per hour in each day. See https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day

Returns:

the punch card

Throws:

IOException - the io exception

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance