Package org.kohsuke.github

Class GHPerson

    • Field Detail

      • login

        protected String login

      • avatar_url

        protected String avatar_url

      • location

        protected String location

      • email

        protected String email

      • company

        protected String company

      • twitter_username

        protected String twitter_username

      • html_url

        protected String html_url

      • followers

        protected int followers

      • following

        protected int following

      • public_repos

        protected int public_repos

      • public_gists

        protected int public_gists

      • site_admin

        protected boolean site_admin

      • hireable

        protected boolean hireable

      • total_private_repos

        protected Integer 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

      • 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

      • 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

      • 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()
        Description copied from class: GHObject
        Gets html url.
        Specified by:
        getHtmlUrl in class GHObject
        Returns:
        URL of this object for humans, which renders some HTML.

      • 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