Package org.kohsuke.github

Class GHPerson

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHPerson

Direct Known Subclasses:

GHOrganization, GHUser

public abstract class GHPerson
extends GHObject

Common part of GHUser and GHOrganization.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected String	avatar_url	The avatar url.
protected String	bio	The twitter username.
protected String	blog	The twitter username.
protected String	company	The twitter username.
protected String	email	The twitter username.
protected int	followers	The public gists.
protected int	following	The public gists.
protected boolean	hireable	The hireable.
protected String	html_url	The html url.
protected String	location	The twitter username.
protected String	login	The avatar url.
protected String	name	The twitter username.
protected int	public_gists	The public gists.
protected int	public_repos	The public gists.
protected boolean	site_admin	The hireable.
protected Integer	total_private_repos	The total private repos.
protected String	twitter_username	The twitter username.
protected String	type	The twitter username.

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHPerson()

Method Summary

Modifier and Type	Method	Description
String	getAvatarUrl()	Returns a string of the avatar image URL.
String	getBlog()	Gets the blog URL of this user.
String	getCompany()	Gets the company name of this user, like "Sun Microsystems, Inc."
Date	getCreatedAt()	Gets the created at.
String	getEmail()	Gets the e-mail address of the user.
int	getFollowersCount()	Gets followers count.
int	getFollowingCount()	Gets following count.
String	getGravatarId()	Deprecated. No longer available in the v3 API.
URL	getHtmlUrl()	Gets the html url.
String	getLocation()	Gets the location of this user, like "Santa Clara, California".
String	getLogin()	Gets the login ID of this user, like 'kohsuke'.
String	getName()	Gets the human-readable name of the user, like "Kohsuke Kawaguchi".
int	getPublicGistCount()	Gets public gist count.
int	getPublicRepoCount()	Gets public repo count.
Map<String,GHRepository>	getRepositories()	Gets the public repositories this user owns.
GHRepository	getRepository(String name)	Gets repository.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
Optional<Integer>	getTotalPrivateRepoCount()	Gets total private repo count.
String	getTwitterUsername()	Gets the Twitter Username of this user, like "GitHub".
String	getType()	Gets the type.
Date	getUpdatedAt()	Gets the updated at.
boolean	isSiteAdmin()	Gets the site_admin field.
Iterable<List<GHRepository>>	iterateRepositories(int pageSize)	Deprecated. Use listRepositories()
abstract PagedIterable<GHEventInfo>	listEvents()	Lists events for an organization or an user.
PagedIterable<GHRepository>	listRepositories()	Lists up all the repositories using a 30 items page size.
PagedIterable<GHRepository>	listRepositories(int pageSize)	Lists up all the repositories using the specified page size.
protected void	populate()	Fully populate the data by retrieving missing data.

Methods inherited from class org.kohsuke.github.GHObject

getId, getNodeId, getResponseHeaderFields, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

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

Field Detail

login

protected String login

The avatar url.

avatar_url

protected String avatar_url

The avatar url.

location

protected String location

The twitter username.

blog

protected String blog

The twitter username.

email

protected String email

The twitter username.

bio

protected String bio

The twitter username.

name

protected String name

The twitter username.

company

protected String company

The twitter username.

type

protected String type

The twitter username.

twitter_username

protected String twitter_username

The twitter username.

html_url

protected String html_url

The html url.

followers

protected int followers

The public gists.

following

protected int following

The public gists.

public_repos

protected int public_repos

The public gists.

public_gists

protected int public_gists

The public gists.

site_admin

protected boolean site_admin

The hireable.

hireable

protected boolean hireable

The hireable.

total_private_repos

protected Integer total_private_repos

The total private repos.

Constructor Detail

GHPerson

public GHPerson()

Method Detail

populate

protected void populate()
                 throws IOException

Fully populate the data by retrieving missing data.

Depending on the original API call where this object is created, it may not contain everything.

Throws:

IOException - the io exception

getRepositories

public Map<String,GHRepository> getRepositories()
                                               throws IOException

Gets the public repositories this user owns.

To list your own repositories, including private repositories, use GHMyself.listRepositories()

Returns:

the repositories

Throws:

IOException - the io exception

listRepositories

public PagedIterable<GHRepository> listRepositories()

Lists up all the repositories using a 30 items page size.

Unlike getRepositories(), this does not wait until all the repositories are returned.

Returns:

the paged iterable

listRepositories

public PagedIterable<GHRepository> listRepositories(int pageSize)

Lists up all the repositories using the specified page size.

Parameters:

pageSize - size for each page of items returned by GitHub. Maximum page size is 100. Unlike getRepositories(), this does not wait until all the repositories are returned.

Returns:

the paged iterable

iterateRepositories

@Deprecated
public Iterable<List<GHRepository>> iterateRepositories(int pageSize)

Deprecated.

Use listRepositories()

Loads repository list in a paginated fashion.

For a person with a lot of repositories, GitHub returns the list of repositories in a paginated fashion. Unlike getRepositories(), this method allows the caller to start processing data as it arrives.

Every Iterator.next() call results in I/O. Exceptions that occur during the processing is wrapped into Error.

Parameters:

pageSize - the page size

Returns:

the iterable

getRepository

public GHRepository getRepository(String name)
                           throws IOException

Gets repository.

Parameters:

name - the name

Returns:

null if the repository was not found

Throws:

IOException - the io exception

listEvents

public abstract PagedIterable<GHEventInfo> listEvents()
                                               throws IOException

Lists events for an organization or an user.

Returns:

the paged iterable

Throws:

IOException - the io exception

getGravatarId

@Deprecated
public String getGravatarId()

Deprecated.

No longer available in the v3 API.

Gravatar ID of this user, like 0cb9832a01c22c083390f3c5dcb64105.

Returns:

the gravatar id

getAvatarUrl

public String getAvatarUrl()

Returns a string of the avatar image URL.

Returns:

the avatar url

getLogin

public String getLogin()

Gets the login ID of this user, like 'kohsuke'.

Returns:

the login

getName

public String getName()
               throws IOException

Gets the human-readable name of the user, like "Kohsuke Kawaguchi".

Returns:

the name

Throws:

IOException - the io exception

getCompany

public String getCompany()
                  throws IOException

Gets the company name of this user, like "Sun Microsystems, Inc."

Returns:

the company

Throws:

IOException - the io exception

getLocation

public String getLocation()
                   throws IOException

Gets the location of this user, like "Santa Clara, California".

Returns:

the location

Throws:

IOException - the io exception

getTwitterUsername

public String getTwitterUsername()
                          throws IOException

Gets the Twitter Username of this user, like "GitHub".

Returns:

the Twitter username

Throws:

IOException - the io exception

getCreatedAt

public Date getCreatedAt()
                  throws IOException

Gets the created at.

Overrides:

getCreatedAt in class GHObject

Returns:

the created at

Throws:

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

getUpdatedAt

public Date getUpdatedAt()
                  throws IOException

Gets the updated at.

Overrides:

getUpdatedAt in class GHObject

Returns:

the updated at

Throws:

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

getBlog

public String getBlog()
               throws IOException

Gets the blog URL of this user.

Returns:

the blog

Throws:

IOException - the io exception

getHtmlUrl

public URL getHtmlUrl()

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

getEmail

public String getEmail()
                throws IOException

Gets the e-mail address of the user.

Returns:

the email

Throws:

IOException - the io exception

getPublicGistCount

public int getPublicGistCount()
                       throws IOException

Gets public gist count.

Returns:

the public gist count

Throws:

IOException - the io exception

getPublicRepoCount

public int getPublicRepoCount()
                       throws IOException

Gets public repo count.

Returns:

the public repo count

Throws:

IOException - the io exception

getFollowingCount

public int getFollowingCount()
                      throws IOException

Gets following count.

Returns:

the following count

Throws:

IOException - the io exception

getFollowersCount

public int getFollowersCount()
                      throws IOException

Gets followers count.

Returns:

the followers count

Throws:

IOException - the io exception

getType

public String getType()
               throws IOException

Gets the type. This is either "User" or "Organization".

Returns:

the type

Throws:

IOException - the io exception

isSiteAdmin

public boolean isSiteAdmin()
                    throws IOException

Gets the site_admin field.

Returns:

the site_admin field

Throws:

IOException - the io exception

getTotalPrivateRepoCount

public Optional<Integer> getTotalPrivateRepoCount()
                                           throws IOException

Gets total private repo count.

Returns:

the total private repo count

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