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

java.lang.Object
  org.eclipse.egit.github.core.service.GitHubService
      org.eclipse.egit.github.core.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 org.eclipse.egit.github.core.service.GitHubService

client

Constructor Summary

MilestoneService()
Create milestone service

MilestoneService(GitHubClient client)
Create milestone service

Method Summary

Milestone	createMilestone(String user, String repository, Milestone milestone) Create a milestone
void	deleteMilestone(String user, String repository, int milestone) Delete a milestone with the given id from the given repository
void	deleteMilestone(String user, String repository, String milestone) Delete a milestone with the given id from the given repository
Milestone	getMilestone(String user, String repository, int number) Get a milestone
Milestone	getMilestone(String user, String repository, String number) Get a milestone
List<Milestone>	getMilestones(String user, String repository, String state) Get milestones

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

MilestoneService

public MilestoneService()

Create milestone service

MilestoneService

public MilestoneService(GitHubClient client)

Create milestone service

Parameters:

client - cannot be null

Method Detail

getMilestones

public List<Milestone> getMilestones(String user,
                                     String repository,
                                     String state)
                              throws IOException

Get milestones

Parameters:

user -

repository -

state -

Returns:

list of milestones

Throws:

IOException

createMilestone

public Milestone createMilestone(String user,
                                 String repository,
                                 Milestone milestone)
                          throws IOException

Create a milestone

Parameters:

user - must be non-null

repository - must be non-null

milestone - must be non-null

Returns:

created milestone

Throws:

IOException

getMilestone

public Milestone getMilestone(String user,
                              String repository,
                              int number)
                       throws IOException

Get a milestone

Parameters:

user - must be non-null

repository - must be non-null

number -

Returns:

created milestone

Throws:

IOException

getMilestone

public Milestone getMilestone(String user,
                              String repository,
                              String number)
                       throws IOException

Get a milestone

Parameters:

user - must be non-null

repository - must be non-null

number - must be non-null

Returns:

created milestone

Throws:

IOException

deleteMilestone

public void deleteMilestone(String user,
                            String repository,
                            int milestone)
                     throws IOException

Delete a milestone with the given id from the given repository

Parameters:

user -

repository -

milestone -

Throws:

IOException

deleteMilestone

public void deleteMilestone(String user,
                            String repository,
                            String milestone)
                     throws IOException

Delete a milestone with the given id from the given repository

Parameters:

user -

repository -

milestone -

Throws:

IOException