com.jcabi.github

Interface Milestones

@Immutable
public interface Milestones

Github Milestones.

Since:

0.7

Version:

$Id$

Author:

Paul Polishchuk (ppol@ua.fm)

See Also:

Milestones API

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.
void	remove(int number) Remove milestone by number.
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

remove

void remove(@NotNull(message="int can never be NULL")
          int number)
            throws IOException

Remove milestone by number.

Parameters:

number - Milestone number

Throws:

IOException - If there is any I/O problem

See Also:

Delete a milestone