com.jcabi.github

Interface DeployKeys

@Immutable
public interface DeployKeys

Github deploy keys.

Since:

0.8

Version:

$Id$

Author:

Andres Candal (andres.candal@rollasolution.com)

See Also:

Deploy Keys API

Method Summary

Methods

Modifier and Type	Method and Description
DeployKey	create(String title, String key) Create a deploy key.
DeployKey	get(int number) Get a single deploy key.
Iterable<DeployKey>	iterate() Iterate them all.
Repo	repo() Owner of them.

Method Detail

repo

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

Owner of them.

Returns:

Repo

iterate

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

Iterate them all.

Returns:

Iterator of deploy keys

See Also:

List

get

@NotNull(message="deploy key is never NULL")
DeployKey get(int number)

Get a single deploy key.

Parameters:

number - Id of a deploy key

Returns:

Deploy key

See Also:

Get a deploy key

create

@NotNull(message="deploy key is never NULL")
DeployKey create(@NotNull(message="title can\'t be NULL")
                              String title,
                              @NotNull(message="key can\'t be NULL")
                              String key)
                 throws IOException

Create a deploy key.

Parameters:

title - Title

key - Key

Returns:

A new deploy key

Throws:

IOException - If there is any I/O problem

See Also:

Add a new deploy key