com.jdroid.github.service

Class EventService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.EventService

public class EventService
extends GitHubService

Service class for interacting with Events

See Also:

GitHub Event API documentation, GitHub Event types API documentation

Field Summary

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

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
EventService() Create event service
EventService(GitHubClient client) Create event service

Method Summary

Modifier and Type	Method and Description
protected PagedRequest<Event>	createNetworkRepoEventRequest(IRepositoryIdProvider repository, int start, int size) Create network repo event page request
protected PagedRequest<Event>	createOrgEventRequest(java.lang.String org, int start, int size) Create org event page request
protected PagedRequest<Event>	createRepoEventRequest(IRepositoryIdProvider repository, int start, int size) Create repo event page request
protected PagedRequest<Event>	createUserEventRequest(java.lang.String user, boolean isPublic, int start, int size) Create user event page request
protected PagedRequest<Event>	createUserOrgEventRequest(java.lang.String user, java.lang.String org, int start, int size) Create user's organization event page request
protected PagedRequest<Event>	createUserReceivedEventRequest(java.lang.String user, boolean isPublic, int start, int size) Create user received event page request
PageIterator<Event>	pageEvents(IRepositoryIdProvider repository) Create page iterator for a given repo's events
PageIterator<Event>	pageEvents(IRepositoryIdProvider repository, int size) Create page iterator for a given repo's events
PageIterator<Event>	pageEvents(IRepositoryIdProvider repository, int start, int size) Create page iterator for a given repo's events
PageIterator<Event>	pageNetworkEvents(IRepositoryIdProvider repository) Create page iterator for a given repo network's events
PageIterator<Event>	pageNetworkEvents(IRepositoryIdProvider repository, int size) Create page iterator for a given repo network's events
PageIterator<Event>	pageNetworkEvents(IRepositoryIdProvider repository, int start, int size) Create page iterator for a given repo network's events
PageIterator<Event>	pageOrgEvents(java.lang.String org) Create page iterator for a given org's events
PageIterator<Event>	pageOrgEvents(java.lang.String org, int size) Create page iterator for a given org's events
PageIterator<Event>	pageOrgEvents(java.lang.String org, int start, int size) Create page iterator for a given org's events
PageIterator<Event>	pagePublicEvents() Create page iterator for all public events
PageIterator<Event>	pagePublicEvents(int size) Create page iterator for all public events
PageIterator<Event>	pagePublicEvents(int start, int size) Create page iterator for all public events
PageIterator<Event>	pageUserEvents(java.lang.String user) Create page iterator for a given user's events Returns private events if authenticated as the user
PageIterator<Event>	pageUserEvents(java.lang.String user, boolean isPublic) Create page iterator for a given user's events
PageIterator<Event>	pageUserEvents(java.lang.String user, boolean isPublic, int size) Create page iterator for a given user's events
PageIterator<Event>	pageUserEvents(java.lang.String user, boolean isPublic, int start, int size) Create page iterator for a given user's events
PageIterator<Event>	pageUserOrgEvents(java.lang.String user, java.lang.String org) Create page iterator for a given user's orgs events
PageIterator<Event>	pageUserOrgEvents(java.lang.String user, java.lang.String org, int size) Create page iterator for a given user's orgs events
PageIterator<Event>	pageUserOrgEvents(java.lang.String user, java.lang.String org, int start, int size) Create page iterator for a given user's orgs events
PageIterator<Event>	pageUserReceivedEvents(java.lang.String user) Create page iterator for a given user's received events Returns private events if authenticated as the user
PageIterator<Event>	pageUserReceivedEvents(java.lang.String user, boolean isPublic) Create page iterator for a given user's received events
PageIterator<Event>	pageUserReceivedEvents(java.lang.String user, boolean isPublic, int size) Create page iterator for a given user's received events
PageIterator<Event>	pageUserReceivedEvents(java.lang.String user, boolean isPublic, int start, int size) Create page iterator for a given user's received events

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

EventService

public EventService()

Create event service

EventService

public EventService(GitHubClient client)

Create event service

Parameters:

client -

Method Detail

pagePublicEvents

public PageIterator<Event> pagePublicEvents()

Create page iterator for all public events

Returns:

events page iterator

pagePublicEvents

public PageIterator<Event> pagePublicEvents(int size)

Create page iterator for all public events

Parameters:

size - size of page

Returns:

events page iterator

pagePublicEvents

public PageIterator<Event> pagePublicEvents(int start,
                                            int size)

Create page iterator for all public events

Parameters:

start - starting page number

size - size of page

Returns:

events page iterator

pageEvents

public PageIterator<Event> pageEvents(IRepositoryIdProvider repository)

Create page iterator for a given repo's events

Parameters:

repository -

Returns:

events page iterator

pageEvents

public PageIterator<Event> pageEvents(IRepositoryIdProvider repository,
                                      int size)

Create page iterator for a given repo's events

Parameters:

repository -

size - size of page

Returns:

events page iterator

pageEvents

public PageIterator<Event> pageEvents(IRepositoryIdProvider repository,
                                      int start,
                                      int size)

Create page iterator for a given repo's events

Parameters:

repository -

start - starting page number

size - size of page

Returns:

events page iterator

pageNetworkEvents

public PageIterator<Event> pageNetworkEvents(IRepositoryIdProvider repository)

Create page iterator for a given repo network's events

Parameters:

repository -

Returns:

events page iterator

pageNetworkEvents

public PageIterator<Event> pageNetworkEvents(IRepositoryIdProvider repository,
                                             int size)

Create page iterator for a given repo network's events

Parameters:

repository -

size - size of page

Returns:

events page iterator

pageNetworkEvents

public PageIterator<Event> pageNetworkEvents(IRepositoryIdProvider repository,
                                             int start,
                                             int size)

Create page iterator for a given repo network's events

Parameters:

repository -

start - starting page number

size - size of page

Returns:

events page iterator

pageOrgEvents

public PageIterator<Event> pageOrgEvents(java.lang.String org)

Create page iterator for a given org's events

Parameters:

org -

Returns:

events page iterator

pageOrgEvents

public PageIterator<Event> pageOrgEvents(java.lang.String org,
                                         int size)

Create page iterator for a given org's events

Parameters:

org -

size - size of page

Returns:

events page iterator

pageOrgEvents

public PageIterator<Event> pageOrgEvents(java.lang.String org,
                                         int start,
                                         int size)

Create page iterator for a given org's events

Parameters:

org -

start - starting page number

size - size of page

Returns:

events page iterator

pageUserReceivedEvents

public PageIterator<Event> pageUserReceivedEvents(java.lang.String user)

Create page iterator for a given user's received events Returns private events if authenticated as the user

Parameters:

user -

Returns:

events page iterator

pageUserReceivedEvents

public PageIterator<Event> pageUserReceivedEvents(java.lang.String user,
                                                  boolean isPublic)

Create page iterator for a given user's received events

Parameters:

user -

isPublic - only include public events?

Returns:

events page iterator

pageUserReceivedEvents

public PageIterator<Event> pageUserReceivedEvents(java.lang.String user,
                                                  boolean isPublic,
                                                  int size)

Create page iterator for a given user's received events

Parameters:

user -

isPublic - only include public events?

size - size of page

Returns:

events page iterator

pageUserReceivedEvents

public PageIterator<Event> pageUserReceivedEvents(java.lang.String user,
                                                  boolean isPublic,
                                                  int start,
                                                  int size)

Create page iterator for a given user's received events

Parameters:

user -

isPublic - only include public events?

start - starting page number

size - size of page

Returns:

events page iterator

pageUserEvents

public PageIterator<Event> pageUserEvents(java.lang.String user)

Create page iterator for a given user's events Returns private events if authenticated as the user

Parameters:

user -

Returns:

events page iterator

pageUserEvents

public PageIterator<Event> pageUserEvents(java.lang.String user,
                                          boolean isPublic)

Create page iterator for a given user's events

Parameters:

user -

isPublic - only include public events?

Returns:

events page iterator

pageUserEvents

public PageIterator<Event> pageUserEvents(java.lang.String user,
                                          boolean isPublic,
                                          int size)

Create page iterator for a given user's events

Parameters:

user -

isPublic - only include public events?

size - size of page

Returns:

events page iterator

pageUserEvents

public PageIterator<Event> pageUserEvents(java.lang.String user,
                                          boolean isPublic,
                                          int start,
                                          int size)

Create page iterator for a given user's events

Parameters:

user -

isPublic - only include public events?

start - starting page number

size - size of page

Returns:

events page iterator

pageUserOrgEvents

public PageIterator<Event> pageUserOrgEvents(java.lang.String user,
                                             java.lang.String org)

Create page iterator for a given user's orgs events

Parameters:

user -

org -

Returns:

events page iterator

pageUserOrgEvents

public PageIterator<Event> pageUserOrgEvents(java.lang.String user,
                                             java.lang.String org,
                                             int size)

Create page iterator for a given user's orgs events

Parameters:

user -

org -

size - size of page

Returns:

events page iterator

pageUserOrgEvents

public PageIterator<Event> pageUserOrgEvents(java.lang.String user,
                                             java.lang.String org,
                                             int start,
                                             int size)

Create page iterator for a given user's orgs events

Parameters:

user -

org -

start - starting page number

size - size of page

Returns:

events page iterator

createRepoEventRequest

protected PagedRequest<Event> createRepoEventRequest(IRepositoryIdProvider repository,
                                                     int start,
                                                     int size)

Create repo event page request

Parameters:

repository -

start - starting page number

size - size of page

Returns:

events page iterator

createNetworkRepoEventRequest

protected PagedRequest<Event> createNetworkRepoEventRequest(IRepositoryIdProvider repository,
                                                            int start,
                                                            int size)

Create network repo event page request

Parameters:

repository -

start - starting page number

size - size of page

Returns:

events page iterator

createOrgEventRequest

protected PagedRequest<Event> createOrgEventRequest(java.lang.String org,
                                                    int start,
                                                    int size)

Create org event page request

Parameters:

org -

start - starting page number

size - size of page

Returns:

events page iterator

createUserReceivedEventRequest

protected PagedRequest<Event> createUserReceivedEventRequest(java.lang.String user,
                                                             boolean isPublic,
                                                             int start,
                                                             int size)

Create user received event page request

Parameters:

user -

isPublic - only include public events?

start - starting page number

size - size of page

Returns:

events page iterator

createUserEventRequest

protected PagedRequest<Event> createUserEventRequest(java.lang.String user,
                                                     boolean isPublic,
                                                     int start,
                                                     int size)

Create user event page request

Parameters:

user -

isPublic - only include public events?

start - starting page number

size - size of page

Returns:

events page iterator

createUserOrgEventRequest

protected PagedRequest<Event> createUserOrgEventRequest(java.lang.String user,
                                                        java.lang.String org,
                                                        int start,
                                                        int size)

Create user's organization event page request

Parameters:

user -

org -

start - starting page number

size - size of page

Returns:

events page iterator