Package org.kohsuke.github

Class GHRepositoryStatistics.ContributorStats

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHRepositoryStatistics.ContributorStats

Enclosing class:

GHRepositoryStatistics

public static class GHRepositoryStatistics.ContributorStats
extends GHObject

The type ContributorStats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHRepositoryStatistics.ContributorStats.Week	The type Week.

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
ContributorStats()

Method Summary

Modifier and Type	Method	Description
GHUser	getAuthor()	Gets author.
URL	getHtmlUrl()	Gets the html url.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
int	getTotal()	Gets total.
GHRepositoryStatistics.ContributorStats.Week	getWeek(long timestamp)	Convenience method to look up week with particular timestamp.
List<GHRepositoryStatistics.ContributorStats.Week>	getWeeks()	Gets weeks.
String	toString()	To string.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields

Methods inherited from class java.lang.Object

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

Constructor Details

ContributorStats

public ContributorStats()

Method Details

getHtmlUrl

public URL getHtmlUrl()
               throws IOException

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

Throws:

IOException - Signals that an I/O exception has occurred.

getAuthor

public GHUser getAuthor()

Gets author.

Returns:

The author described by these statistics.

getTotal

public int getTotal()

Gets total.

Returns:

The total number of commits authored by the contributor.

getWeek

public GHRepositoryStatistics.ContributorStats.Week getWeek(long timestamp)
                                                     throws NoSuchElementException

Convenience method to look up week with particular timestamp.

Parameters:

timestamp - The timestamp to look for.

Returns:

The week starting with the given timestamp. Throws an exception if it is not found.

Throws:

NoSuchElementException - the no such element exception

getWeeks

public List<GHRepositoryStatistics.ContributorStats.Week> getWeeks()

Gets weeks.

Returns:

The total number of commits authored by the contributor.

toString

public String toString()

To string.

Overrides:

toString in class GHObject

Returns:

the string

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