com.jdroid.github.service

Class MilestoneService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.MilestoneService

public class MilestoneService
extends GitHubService

Milestone service class for listing the Milestone objects in use by a repository and user accessed via a GitHubClient.

See Also:

GitHub milestones 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
MilestoneService() Create milestone service
MilestoneService(GitHubClient client) Create milestone service

Method Summary

Modifier and Type	Method and Description
Milestone	createMilestone(IRepositoryIdProvider repository, Milestone milestone) Create a milestone
Milestone	createMilestone(java.lang.String user, java.lang.String repository, Milestone milestone) Create a milestone
void	deleteMilestone(IRepositoryIdProvider repository, int milestone) Delete a milestone with the given id from the given repository
void	deleteMilestone(IRepositoryIdProvider repository, java.lang.String milestone) Delete a milestone with the given id from the given repository
void	deleteMilestone(java.lang.String user, java.lang.String repository, int milestone) Delete a milestone with the given id from the given repository
void	deleteMilestone(java.lang.String user, java.lang.String repository, java.lang.String milestone) Delete a milestone with the given id from the given repository
Milestone	editMilestone(IRepositoryIdProvider repository, Milestone milestone) Edit the given milestone in the given repository
Milestone	getMilestone(IRepositoryIdProvider repository, int number) Get a milestone
Milestone	getMilestone(IRepositoryIdProvider repository, java.lang.String number) Get a milestone
Milestone	getMilestone(java.lang.String user, java.lang.String repository, int number) Get a milestone
Milestone	getMilestone(java.lang.String user, java.lang.String repository, java.lang.String number) Get a milestone
java.util.List<Milestone>	getMilestones(IRepositoryIdProvider repository, java.lang.String state) Get milestones
java.util.List<Milestone>	getMilestones(java.lang.String user, java.lang.String repository, java.lang.String state) Get milestones

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

MilestoneService

public MilestoneService()

Create milestone service

MilestoneService

public MilestoneService(GitHubClient client)

Create milestone service

Parameters:

client - cannot be null

Method Detail

getMilestones

public java.util.List<Milestone> getMilestones(IRepositoryIdProvider repository,
                                               java.lang.String state)
                                        throws java.io.IOException

Get milestones

Parameters:

repository -

state -

Returns:

list of milestones

Throws:

java.io.IOException

getMilestones

public java.util.List<Milestone> getMilestones(java.lang.String user,
                                               java.lang.String repository,
                                               java.lang.String state)
                                        throws java.io.IOException

Get milestones

Parameters:

user -

repository -

state -

Returns:

list of milestones

Throws:

java.io.IOException

createMilestone

public Milestone createMilestone(IRepositoryIdProvider repository,
                                 Milestone milestone)
                          throws java.io.IOException

Create a milestone

Parameters:

repository - must be non-null

milestone - must be non-null

Returns:

created milestone

Throws:

java.io.IOException

createMilestone

public Milestone createMilestone(java.lang.String user,
                                 java.lang.String repository,
                                 Milestone milestone)
                          throws java.io.IOException

Create a milestone

Parameters:

user - must be non-null

repository - must be non-null

milestone - must be non-null

Returns:

created milestone

Throws:

java.io.IOException

getMilestone

public Milestone getMilestone(IRepositoryIdProvider repository,
                              int number)
                       throws java.io.IOException

Get a milestone

Parameters:

repository - must be non-null

number -

Returns:

created milestone

Throws:

java.io.IOException

getMilestone

public Milestone getMilestone(IRepositoryIdProvider repository,
                              java.lang.String number)
                       throws java.io.IOException

Get a milestone

Parameters:

repository - must be non-null

number - must be non-null

Returns:

created milestone

Throws:

java.io.IOException

getMilestone

public Milestone getMilestone(java.lang.String user,
                              java.lang.String repository,
                              int number)
                       throws java.io.IOException

Get a milestone

Parameters:

user - must be non-null

repository - must be non-null

number -

Returns:

created milestone

Throws:

java.io.IOException

getMilestone

public Milestone getMilestone(java.lang.String user,
                              java.lang.String repository,
                              java.lang.String number)
                       throws java.io.IOException

Get a milestone

Parameters:

user - must be non-null

repository - must be non-null

number - must be non-null

Returns:

created milestone

Throws:

java.io.IOException

deleteMilestone

public void deleteMilestone(IRepositoryIdProvider repository,
                            int milestone)
                     throws java.io.IOException

Delete a milestone with the given id from the given repository

Parameters:

repository -

milestone -

Throws:

java.io.IOException

deleteMilestone

public void deleteMilestone(IRepositoryIdProvider repository,
                            java.lang.String milestone)
                     throws java.io.IOException

Delete a milestone with the given id from the given repository

Parameters:

repository -

milestone -

Throws:

java.io.IOException

deleteMilestone

public void deleteMilestone(java.lang.String user,
                            java.lang.String repository,
                            int milestone)
                     throws java.io.IOException

Delete a milestone with the given id from the given repository

Parameters:

user -

repository -

milestone -

Throws:

java.io.IOException

deleteMilestone

public void deleteMilestone(java.lang.String user,
                            java.lang.String repository,
                            java.lang.String milestone)
                     throws java.io.IOException

Delete a milestone with the given id from the given repository

Parameters:

user -

repository -

milestone -

Throws:

java.io.IOException

editMilestone

public Milestone editMilestone(IRepositoryIdProvider repository,
                               Milestone milestone)
                        throws java.io.IOException

Edit the given milestone in the given repository

Parameters:

repository -

milestone -

Returns:

edited milestone

Throws:

java.io.IOException