org.eclipse.egit.github.core.service
Class WatcherService

java.lang.Object
  extended by org.eclipse.egit.github.core.service.GitHubService
      extended by org.eclipse.egit.github.core.service.WatcherService

public class WatcherService
extends GitHubService

Service class for dealing with users watching GitHub repositories.

See Also:
GitHub watcher API documentation

Field Summary
 
Fields inherited from class org.eclipse.egit.github.core.service.GitHubService
ACCEPT_FULL, ACCEPT_HTML, ACCEPT_TEXT, client
 
Constructor Summary
WatcherService()
          Create watcher service
WatcherService(GitHubClient client)
          Create watcher service
 
Method Summary
protected  PagedRequest<Repository> createWatchedRequest(int start, int size)
          Create page watched request
protected  PagedRequest<Repository> createWatchedRequest(String user, int start, int size)
          Create page watched request
protected  PagedRequest<User> createWatcherRequest(IRepositoryIdProvider repository, int start, int size)
          Create page watcher request
 List<Repository> getWatched()
          Get repositories watched by the currently authenticated user
 List<Repository> getWatched(String user)
          Get repositories watched by the given user
 List<User> getWatchers(IRepositoryIdProvider repository)
          Get user watching given repository
 boolean isWatching(IRepositoryIdProvider repository)
          Is currently authenticated user watching given repository?
 PageIterator<Repository> pageWatched()
          Page repositories being watched by the currently authenticated user
 PageIterator<Repository> pageWatched(int size)
          Page repositories being watched by the currently authenticated user
 PageIterator<Repository> pageWatched(int start, int size)
          Page repositories being watched by the currently authenticated user
 PageIterator<Repository> pageWatched(String user)
          Page repositories being watched by given user
 PageIterator<Repository> pageWatched(String user, int size)
          Page repositories being watched by given user
 PageIterator<Repository> pageWatched(String user, int start, int size)
          Page repositories being watched by given user
 PageIterator<User> pageWatchers(IRepositoryIdProvider repository)
          Page watches of given repository
 PageIterator<User> pageWatchers(IRepositoryIdProvider repository, int size)
          Page watches of given repository
 PageIterator<User> pageWatchers(IRepositoryIdProvider repository, int start, int size)
          Page watches of given repository
 void unwatch(IRepositoryIdProvider repository)
          Remove currently authenticated user as a watcher of the given repository
 void watch(IRepositoryIdProvider repository)
          Add currently authenticated user as a watcher of the given repository
 
Methods inherited from class org.eclipse.egit.github.core.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

WatcherService

public WatcherService()
Create watcher service


WatcherService

public WatcherService(GitHubClient client)
Create watcher service

Parameters:
client -
Method Detail

createWatcherRequest

protected PagedRequest<User> createWatcherRequest(IRepositoryIdProvider repository,
                                                  int start,
                                                  int size)
Create page watcher request

Parameters:
repository -
start -
size -
Returns:
request

getWatchers

public List<User> getWatchers(IRepositoryIdProvider repository)
                       throws IOException
Get user watching given repository

Parameters:
repository -
Returns:
non-null but possibly empty list of users
Throws:
IOException

pageWatchers

public PageIterator<User> pageWatchers(IRepositoryIdProvider repository)
Page watches of given repository

Parameters:
repository -
Returns:
page iterator

pageWatchers

public PageIterator<User> pageWatchers(IRepositoryIdProvider repository,
                                       int size)
Page watches of given repository

Parameters:
repository -
size -
Returns:
page iterator

pageWatchers

public PageIterator<User> pageWatchers(IRepositoryIdProvider repository,
                                       int start,
                                       int size)
Page watches of given repository

Parameters:
repository -
start -
size -
Returns:
page iterator

createWatchedRequest

protected PagedRequest<Repository> createWatchedRequest(String user,
                                                        int start,
                                                        int size)
Create page watched request

Parameters:
user -
start -
size -
Returns:
request

createWatchedRequest

protected PagedRequest<Repository> createWatchedRequest(int start,
                                                        int size)
Create page watched request

Parameters:
start -
size -
Returns:
request

getWatched

public List<Repository> getWatched(String user)
                            throws IOException
Get repositories watched by the given user

Parameters:
user -
Returns:
non-null but possibly empty list of repositories
Throws:
IOException

pageWatched

public PageIterator<Repository> pageWatched(String user)
                                     throws IOException
Page repositories being watched by given user

Parameters:
user -
Returns:
page iterator
Throws:
IOException

pageWatched

public PageIterator<Repository> pageWatched(String user,
                                            int size)
                                     throws IOException
Page repositories being watched by given user

Parameters:
user -
size -
Returns:
page iterator
Throws:
IOException

pageWatched

public PageIterator<Repository> pageWatched(String user,
                                            int start,
                                            int size)
                                     throws IOException
Page repositories being watched by given user

Parameters:
user -
start -
size -
Returns:
page iterator
Throws:
IOException

getWatched

public List<Repository> getWatched()
                            throws IOException
Get repositories watched by the currently authenticated user

Returns:
non-null but possibly empty list of repositories
Throws:
IOException

pageWatched

public PageIterator<Repository> pageWatched()
                                     throws IOException
Page repositories being watched by the currently authenticated user

Returns:
page iterator
Throws:
IOException

pageWatched

public PageIterator<Repository> pageWatched(int size)
                                     throws IOException
Page repositories being watched by the currently authenticated user

Parameters:
size -
Returns:
page iterator
Throws:
IOException

pageWatched

public PageIterator<Repository> pageWatched(int start,
                                            int size)
                                     throws IOException
Page repositories being watched by the currently authenticated user

Parameters:
start -
size -
Returns:
page iterator
Throws:
IOException

isWatching

public boolean isWatching(IRepositoryIdProvider repository)
                   throws IOException
Is currently authenticated user watching given repository?

Parameters:
repository -
Returns:
true if watch, false otherwise
Throws:
IOException

watch

public void watch(IRepositoryIdProvider repository)
           throws IOException
Add currently authenticated user as a watcher of the given repository

Parameters:
repository -
Throws:
IOException

unwatch

public void unwatch(IRepositoryIdProvider repository)
             throws IOException
Remove currently authenticated user as a watcher of the given repository

Parameters:
repository -
Throws:
IOException


Copyright © 2012. All Rights Reserved.