Package com.sudicode.fb2gh.github

Interface GHRepo

public interface GHRepo

GitHub repository.

Method Summary

Modifier and Type	Method	Description
GHIssue	addIssue(String title, String description)	Create an issue.
void	addLabel(GHLabel label)	Add a label.
GHMilestone	addMilestone(String title)	Create a milestone.
GHIssue	getIssue(int number)	Get an issue by number.
List<GHLabel>	getLabels()	Get the labels within this repository.
GHMilestone	getMilestone(int number)	Get a single milestone.
List<GHMilestone>	getMilestones()	Get all milestones within this repository.
String	getName()
String	getOwner()

Method Detail

addMilestone

GHMilestone addMilestone(String title)
                  throws FB2GHException

Create a milestone.

Parameters:

title - The title of the milestone

Returns:

The milestone

Throws:

FB2GHException - if a GitHub error occurs

getMilestone

GHMilestone getMilestone(int number)
                  throws FB2GHException

Get a single milestone.

Parameters:

number - The number of the milestone

Returns:

The milestone

Throws:

FB2GHException - if a GitHub error occurs

getMilestones

List<GHMilestone> getMilestones()
                         throws FB2GHException

Get all milestones within this repository.

Returns:

A list of the milestones.

Throws:

FB2GHException - if a GitHub error occurs

addIssue

GHIssue addIssue(String title,
                 String description)
          throws FB2GHException

Create an issue.

Parameters:

title - Title of the issue

description - Description of the issue

Returns:

The created issue

Throws:

FB2GHException - if a GitHub error occurs

getIssue

GHIssue getIssue(int number)

Get an issue by number.

Parameters:

number - Number of the issue

Returns:

The issue

addLabel

void addLabel(GHLabel label)
       throws FB2GHException

Add a label.

Parameters:

label - The label to add.

Throws:

FB2GHException - if a GitHub error occurs

getLabels

List<GHLabel> getLabels()
                 throws FB2GHException

Get the labels within this repository.

Returns:

A list of the labels.

Throws:

FB2GHException - if a GitHub error occurs

getOwner

String getOwner()

Returns:

The owner of this repository.

getName

String getName()

Returns:

The name of this repository.