com.jcabi.github

Interface PublicKey

All Superinterfaces:

JsonPatchable, JsonReadable

All Known Implementing Classes:

PublicKey.Smart

@Immutable
public interface PublicKey
extends JsonReadable, JsonPatchable

Github public key.

PublicKey implements JsonReadable, that's how you can get its full details in JSON format. For example, to get its title, you get the entire JSON and then gets its element:

String title = key.json().getString("title");

However, it's better to use a supplementary "smart" decorator, which automates most of these operations:

String title = new PublicKey.Smart(comment).title();

Version:

$Id$

Author:

Carlos Miranda (miranda.cma@gmail.com)

See Also:

Public Keys API

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
int	number() ID Number of this public key.
User	user() User we're in.

Methods inherited from interface com.jcabi.github.JsonReadable

json

Methods inherited from interface com.jcabi.github.JsonPatchable

patch

Method Detail

user

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

User we're in.

Returns:

User

number

int number()

ID Number of this public key.

Returns:

Public key ID number