com.jcabi.github

Interface PublicKeys

@Immutable
public interface PublicKeys

Github public keys.

Version:

$Id$

Author:

Carlos Miranda (miranda.cma@gmail.com)

See Also:

Public Keys API

Method Summary

Methods

Modifier and Type	Method and Description
PublicKey	create(String title, String key) Create a public key.
PublicKey	get(int number) Get a single public key.
Iterable<PublicKey>	iterate() Iterate all public keys.
void	remove(int number) Remove a public key.
User	user() User we're in.

Method Detail

user

@NotNull(message="user is never NULL")
User user()

User we're in.

Returns:

User

iterate

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

Iterate all public keys.

Returns:

All public keys.

See Also:

List your public keys.

get

@NotNull(message="PublicKey is never NULL")
PublicKey get(int number)

Get a single public key.

Parameters:

number - ID of the public key to remove.

Returns:

A single public key.

See Also:

Get a single public key.

create

@NotNull(message="PublicKey is never NULL")
PublicKey create(@NotNull(message="title is never NULL")
                              String title,
                              @NotNull(message="key is never NULL")
                              String key)
                 throws IOException

Create a public key.

Parameters:

title - The title of this key.

key - The value of this key.

Returns:

A new PublicKey

Throws:

IOException - If an IO problem occurs.

See Also:

Create a public key.

remove

void remove(int number)
            throws IOException

Remove a public key.

Parameters:

number - ID of the public key to remove.

Throws:

IOException - If an IO problem occurs.

See Also:

Delete a public key.