Package com.jcabi.github

Interface IssueLabels

All Known Implementing Classes:

IssueLabels.Smart

@Immutable
public interface IssueLabels

Github labels of an issue.

Since:

0.1

Version:

$Id: 918106ac9a3f6cb7f97da51698b63ce3c98d1381 $

Author:

Yegor Bugayenko (yegor256@gmail.com)

See Also:

Labels API

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IssueLabels.Smart	Smart IssueLabels with extra features.

Method Summary

Modifier and Type	Method	Description
void	add(Iterable<String> labels)	Add new labels.
void	clear()	Remove all labels.
Issue	issue()	The issue we're in.
Iterable<Label>	iterate()	Iterate them all.
void	remove(String name)	Remove label by name.
void	replace(Iterable<String> labels)	Replace all labels.

Method Detail

issue

Issue issue()

The issue we're in.

Returns:

Issue

add

void add(Iterable<String> labels)
  throws IOException

Add new labels.

Parameters:

labels - The labels to add

Throws:

IOException - If there is any I/O problem

See Also:

Add labels to an issue

replace

void replace(Iterable<String> labels)
      throws IOException

Replace all labels.

Parameters:

labels - The labels to save

Throws:

IOException - If there is any I/O problem

See Also:

Replace all labels for an issue

iterate

Iterable<Label> iterate()

Iterate them all.

Returns:

Iterator of labels

See Also:

List Labels on an Issue

remove

void remove(String name)
     throws IOException

Remove label by name.

Parameters:

name - Name of the label to remove

Throws:

IOException - If there is any I/O problem

See Also:

Remove a Label from an Issue

clear

void clear()
    throws IOException

Remove all labels.

Throws:

IOException - If there is any I/O problem

See Also:

Remove all labels from an issue