com.jcabi.github

Interface Milestones

All Known Implementing Classes:

RtMilestones

@Immutable
public interface Milestones

Github Milestones.

Since:

0.7

Version:

$Id$

Author:

Paul Polishchuk (ppol@ua.fm)

See Also:

Milestones API

To do:

#1:1hr New method remove() to delete a Milestone. Let's add a new method to remove a milestone by id, as explained in http://developer.github.com/v3/issues/milestones/#delete-a-milestone. The method should be tested by unit and integration tests.

Method Summary

Methods

Modifier and Type	Method and Description
Milestone	create(String title) Create Milestone.
Milestone	get(int number) Get specific milestone by number.
Iterable<Milestone>	iterate(Map<String,String> params) Iterate them all.
Repo	repo() Owner of them.

Method Detail

repo

@NotNull(message="repository is never NULL")
Repo repo()

Owner of them.

Returns:

Repo

create

@NotNull(message="repository is never NULL")
Milestone create(@NotNull(message="Title can\'t be NULL")
                              String title)
                 throws IOException

Create Milestone.

Parameters:

title - Milestone creation JSON

Returns:

Milestone

Throws:

IOException - If there is any I/O problem

Since:

0.5

See Also:

Create Milestone

get

@NotNull(message="milestone is never NULL")
Milestone get(int number)

Get specific milestone by number.

Parameters:

number - Milestone number

Returns:

Milestone

See Also:

Get a single milestone

iterate

@NotNull(message="iterable is never NULL")
Iterable<Milestone> iterate(@NotNull(message="map of params can\'t be NULL")
                                         Map<String,String> params)

Iterate them all.

Parameters:

params - Iterating parameters, as requested by API

Returns:

Iterator of milestones

See Also:

List milestones for a repository