com.jcabi.github

Class RtMilestones

java.lang.Object

com.jcabi.github.RtMilestones

All Implemented Interfaces:

Milestones

@Immutable
@Loggable(value=1)
public class RtMilestones
extends Object
implements Milestones

Github milestones.

Since:

0.7

Version:

$Id$

Author:

Paul Polishchuk (ppol@ua.fm)

Suppressed Checkstyle violations:

MultipleStringLiterals (500 lines)

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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

repo

public final Repo repo()

Description copied from interface: Milestones

Owner of them.

Specified by:

repo in interface Milestones

Returns:

Repo

create

public final Milestone create(@NotNull(message="title can\'t be NULL")
               String title)
                       throws IOException

Description copied from interface: Milestones

Create Milestone.

Specified by:

create in interface Milestones

Parameters:

title - Milestone creation JSON

Returns:

Milestone

Throws:

IOException - If there is any I/O problem

See Also:

Create Milestone

get

public final Milestone get(int number)

Description copied from interface: Milestones

Get specific milestone by number.

Specified by:

get in interface Milestones

Parameters:

number - Milestone number

Returns:

Milestone

See Also:

Get a single milestone

iterate

public final Iterable<Milestone> iterate(@NotNull(message="map or params can\'t be NULL")
                          Map<String,String> params)

Description copied from interface: Milestones

Iterate them all.

Specified by:

iterate in interface Milestones

Parameters:

params - Iterating parameters, as requested by API

Returns:

Iterator of milestones

See Also:

List milestones for a repository