com.jcabi.github

Interface Labels

All Known Implementing Classes:

Labels.Smart

@Immutable
public interface Labels

Github labels.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Labels API

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
Label	create(String name, String color) Create new label.
void	delete(String name) Delete label by name.
Label	get(String name) Get a label by name.
Iterable<Label>	iterate() Iterate them all.
Repo	repo() The repo we're in.

Method Detail

repo

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

The repo we're in.

Returns:

Repo

create

@NotNull(message="Label is never NULL")
Label create(@NotNull(message="label name can\'t be NULL")
                   String name,
                   @NotNull(message="label color can\'t be NULL")
                   String color)
             throws IOException

Create new label.

Parameters:

name - The name of it

color - Color of it

Returns:

The label created

Throws:

IOException - If there is any I/O problem

See Also:

Create a Label

get

@NotNull(message="Label is never NULL")
Label get(@NotNull(message="label name can\'t be NULL")
                String name)

Get a label by name.

Parameters:

name - The name of it

Returns:

The label

See Also:

Get a single label

iterate

@NotNull(message="iterable is never NULL")
Iterable<Label> iterate()

Iterate them all.

Returns:

Iterator of labels

See Also:

List Labels on an Issue

delete

void delete(@NotNull(message="label name can\'t be NULL")
          String name)
            throws IOException

Delete label by name.

Parameters:

name - Name of the label to remove

Throws:

IOException - If there is any I/O problem

See Also:

Delete a Label