Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
PublicKeys |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright (c) 2013-2017, jcabi.com | |
3 | * All rights reserved. | |
4 | * | |
5 | * Redistribution and use in source and binary forms, with or without | |
6 | * modification, are permitted provided that the following conditions | |
7 | * are met: 1) Redistributions of source code must retain the above | |
8 | * copyright notice, this list of conditions and the following | |
9 | * disclaimer. 2) Redistributions in binary form must reproduce the above | |
10 | * copyright notice, this list of conditions and the following | |
11 | * disclaimer in the documentation and/or other materials provided | |
12 | * with the distribution. 3) Neither the name of the jcabi.com nor | |
13 | * the names of its contributors may be used to endorse or promote | |
14 | * products derived from this software without specific prior written | |
15 | * permission. | |
16 | * | |
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT | |
19 | * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | |
20 | * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL | |
21 | * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
22 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
23 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
25 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
26 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | |
28 | * OF THE POSSIBILITY OF SUCH DAMAGE. | |
29 | */ | |
30 | package com.jcabi.github; | |
31 | ||
32 | import com.jcabi.aspects.Immutable; | |
33 | import java.io.IOException; | |
34 | ||
35 | /** | |
36 | * Github public keys. | |
37 | * | |
38 | * @author Carlos Miranda (miranda.cma@gmail.com) | |
39 | * @version $Id: b04485d9df6a8275472502ba8faa0c274706f4f5 $ | |
40 | * @see <a href="http://developer.github.com/v3/users/keys/">Public Keys API</a> | |
41 | */ | |
42 | @Immutable | |
43 | public interface PublicKeys { | |
44 | ||
45 | /** | |
46 | * User we're in. | |
47 | * | |
48 | * @return User | |
49 | */ | |
50 | User user(); | |
51 | ||
52 | /** | |
53 | * Iterate all public keys. | |
54 | * | |
55 | * @return All public keys. | |
56 | * @see <a href="http://developer.github.com/v3/users/keys#list-your-public-keys/">List your public keys.</a> | |
57 | */ | |
58 | Iterable<PublicKey> iterate(); | |
59 | ||
60 | /** | |
61 | * Get a single public key. | |
62 | * | |
63 | * @param number ID of the public key to remove. | |
64 | * @return A single public key. | |
65 | * @see <a href="http://developer.github.com/v3/users/keys#get-a-single-public-key/">Get a single public key.</a> | |
66 | */ | |
67 | PublicKey get(int number); | |
68 | ||
69 | /** | |
70 | * Create a public key. | |
71 | * | |
72 | * @param title The title of this key. | |
73 | * @param key The value of this key. | |
74 | * @return A new PublicKey | |
75 | * @throws IOException If an IO problem occurs. | |
76 | * @see <a href="http://developer.github.com/v3/users/keys/#create-a-public-key/">Create a public key.</a> | |
77 | */ | |
78 | PublicKey create( | |
79 | String title, | |
80 | String key | |
81 | ) throws IOException; | |
82 | ||
83 | /** | |
84 | * Remove a public key. | |
85 | * | |
86 | * @param number ID of the public key to remove. | |
87 | * @throws IOException If an IO problem occurs. | |
88 | * @see <a href="http://developer.github.com/v3/users/keys/#delete-a-public-key/">Delete a public key.</a> | |
89 | */ | |
90 | void remove(int number) throws IOException; | |
91 | ||
92 | } |