com.jdroid.github.service

Class StargazerService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.StargazerService

public class StargazerService
extends GitHubService

Service class for dealing with users starring GitHub repositories.

Since:

4.2

See Also:

GitHub stargazer API documentation

Field Summary

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
StargazerService() Create stargazer service
StargazerService(GitHubClient client) Create stargazer service

Method Summary

Modifier and Type	Method and Description
protected PagedRequest<User>	createStargazerRequest(IRepositoryIdProvider repository, int start, int size) Create page stargazer request
protected PagedRequest<Repository>	createStarredRequest(int start, int size) Create page starred request
protected PagedRequest<Repository>	createStarredRequest(java.lang.String user, int start, int size) Create page starred request
java.util.List<User>	getStargazers(IRepositoryIdProvider repository) Get users starring the given repository
java.util.List<Repository>	getStarred() Get repositories starred by the currently authenticated user
java.util.List<Repository>	getStarred(java.lang.String user) Get repositories starred by the given user
boolean	isStarring(IRepositoryIdProvider repository) Is currently authenticated user starring given repository?
PageIterator<User>	pageStargazers(IRepositoryIdProvider repository) Page stargazers of given repository
PageIterator<User>	pageStargazers(IRepositoryIdProvider repository, int size) Page stargazers of given repository
PageIterator<User>	pageStargazers(IRepositoryIdProvider repository, int start, int size) Page stargazers of given repository
PageIterator<Repository>	pageStarred() Page repositories starred by the currently authenticated user
PageIterator<Repository>	pageStarred(int size) Page repositories starred by the currently authenticated user
PageIterator<Repository>	pageStarred(int start, int size) Page repositories starred by the currently authenticated user
PageIterator<Repository>	pageStarred(java.lang.String user) Page repositories starred by given user
PageIterator<Repository>	pageStarred(java.lang.String user, int size) Page repositories starred by given user
PageIterator<Repository>	pageStarred(java.lang.String user, int start, int size) Page repositories starred by given user
void	star(IRepositoryIdProvider repository) Add currently authenticated user as a stargazer of the given repository
void	unstar(IRepositoryIdProvider repository) Remove currently authenticated user as a stargazer of the given repository

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

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

Constructor Detail

StargazerService

public StargazerService()

Create stargazer service

StargazerService

public StargazerService(GitHubClient client)

Create stargazer service

Parameters:

client -

Method Detail

createStargazerRequest

protected PagedRequest<User> createStargazerRequest(IRepositoryIdProvider repository,
                                                    int start,
                                                    int size)

Create page stargazer request

Parameters:

repository -

start -

size -

Returns:

request

getStargazers

public java.util.List<User> getStargazers(IRepositoryIdProvider repository)
                                   throws java.io.IOException

Get users starring the given repository

Parameters:

repository -

Returns:

non-null but possibly empty list of users

Throws:

java.io.IOException

pageStargazers

public PageIterator<User> pageStargazers(IRepositoryIdProvider repository)

Page stargazers of given repository

Parameters:

repository -

Returns:

page iterator

pageStargazers

public PageIterator<User> pageStargazers(IRepositoryIdProvider repository,
                                         int size)

Page stargazers of given repository

Parameters:

repository -

size -

Returns:

page iterator

pageStargazers

public PageIterator<User> pageStargazers(IRepositoryIdProvider repository,
                                         int start,
                                         int size)

Page stargazers of given repository

Parameters:

repository -

start -

size -

Returns:

page iterator

createStarredRequest

protected PagedRequest<Repository> createStarredRequest(java.lang.String user,
                                                        int start,
                                                        int size)

Create page starred request

Parameters:

user -

start -

size -

Returns:

request

createStarredRequest

protected PagedRequest<Repository> createStarredRequest(int start,
                                                        int size)

Create page starred request

Parameters:

start -

size -

Returns:

request

getStarred

public java.util.List<Repository> getStarred(java.lang.String user)
                                      throws java.io.IOException

Get repositories starred by the given user

Parameters:

user -

Returns:

non-null but possibly empty list of repositories

Throws:

java.io.IOException

pageStarred

public PageIterator<Repository> pageStarred(java.lang.String user)
                                     throws java.io.IOException

Page repositories starred by given user

Parameters:

user -

Returns:

page iterator

Throws:

java.io.IOException

pageStarred

public PageIterator<Repository> pageStarred(java.lang.String user,
                                            int size)
                                     throws java.io.IOException

Page repositories starred by given user

Parameters:

user -

size -

Returns:

page iterator

Throws:

java.io.IOException

pageStarred

public PageIterator<Repository> pageStarred(java.lang.String user,
                                            int start,
                                            int size)
                                     throws java.io.IOException

Page repositories starred by given user

Parameters:

user -

start -

size -

Returns:

page iterator

Throws:

java.io.IOException

getStarred

public java.util.List<Repository> getStarred()
                                      throws java.io.IOException

Get repositories starred by the currently authenticated user

Returns:

non-null but possibly empty list of repositories

Throws:

java.io.IOException

pageStarred

public PageIterator<Repository> pageStarred()
                                     throws java.io.IOException

Page repositories starred by the currently authenticated user

Returns:

page iterator

Throws:

java.io.IOException

pageStarred

public PageIterator<Repository> pageStarred(int size)
                                     throws java.io.IOException

Page repositories starred by the currently authenticated user

Parameters:

size -

Returns:

page iterator

Throws:

java.io.IOException

pageStarred

public PageIterator<Repository> pageStarred(int start,
                                            int size)
                                     throws java.io.IOException

Page repositories starred by the currently authenticated user

Parameters:

start -

size -

Returns:

page iterator

Throws:

java.io.IOException

isStarring

public boolean isStarring(IRepositoryIdProvider repository)
                   throws java.io.IOException

Is currently authenticated user starring given repository?

Parameters:

repository -

Returns:

true if starred, false otherwise

Throws:

java.io.IOException

star

public void star(IRepositoryIdProvider repository)
          throws java.io.IOException

Add currently authenticated user as a stargazer of the given repository

Parameters:

repository -

Throws:

java.io.IOException

unstar

public void unstar(IRepositoryIdProvider repository)
            throws java.io.IOException

Remove currently authenticated user as a stargazer of the given repository

Parameters:

repository -

Throws:

java.io.IOException