com.jcabi.github

Class Labels.Smart

java.lang.Object

com.jcabi.github.Labels.Smart

All Implemented Interfaces:

Labels

Enclosing interface:

Labels

@Immutable
@Loggable(value=1)
public static final class Labels.Smart
extends Object
implements Labels

Smart Labels with extra features.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Labels

Labels.Smart

Constructor Summary

Constructors

Constructor and Description
Labels.Smart(Labels lbl) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String name) Label exists?
Label	create(String name, String color) Create new label.
Label	createOrGet(String name) Create or get label.
Label	createOrGet(String name, String color) Create or get label (with this explicit color).
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Labels.Smart

public Labels.Smart(@NotNull(message="lbl can\'t be NULL")
            Labels lbl)

Public ctor.

Parameters:

lbl - Labels

Method Detail

contains

public boolean contains(@NotNull(message="name cannot be NULL")
               String name)

Label exists?

Parameters:

name - Name of the label

Returns:

TRUE if it exists

createOrGet

@NotNull(message="label should never be NULL")
public Label createOrGet(@NotNull(message="name is not NULL")
                               String name)
                  throws IOException

Create or get label.

Parameters:

name - Name of the label

Returns:

Label found or created

Throws:

IOException - If there is any I/O problem

createOrGet

@NotNull(message="label should not be NULL")
public Label createOrGet(@NotNull(message="name shouldn\'t be NULL")
                               String name,
                               @NotNull(message="color can\'t be NULL")
                               String color)
                  throws IOException

Create or get label (with this explicit color).

Parameters:

name - Name of the label

color - Color to set (or modify)

Returns:

Label found or created

Throws:

IOException - If there is any I/O problem

Since:

0.7

repo

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

Description copied from interface: Labels

The repo we're in.

Specified by:

repo in interface Labels

Returns:

Repo

create

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

Description copied from interface: Labels

Create new label.

Specified by:

create in interface Labels

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")
public Label get(@NotNull(message="name can\'t be NULL")
                       String name)

Description copied from interface: Labels

Get a label by name.

Specified by:

get in interface Labels

Parameters:

name - The name of it

Returns:

The label

See Also:

Get a single label

iterate

@NotNull(message="Iterable of labels is never NULL")
public Iterable<Label> iterate()

Description copied from interface: Labels

Iterate them all.

Specified by:

iterate in interface Labels

Returns:

Iterator of labels

See Also:

List Labels on an Issue

delete

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

Description copied from interface: Labels

Delete label by name.

Specified by:

delete in interface Labels

Parameters:

name - Name of the label to remove

Throws:

IOException - If there is any I/O problem

See Also:

Delete a Label