Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Gists |
|
| 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 | import java.util.Map; | |
35 | ||
36 | /** | |
37 | * Github gists. | |
38 | * | |
39 | * @author Yegor Bugayenko (yegor@tpc2.com) | |
40 | * @version $Id: 11ced1d534de5a8299c876a0c7c857934fc439d2 $ | |
41 | * @since 0.1 | |
42 | * @see <a href="http://developer.github.com/v3/gists/">Gists API</a> | |
43 | */ | |
44 | @Immutable | |
45 | public interface Gists { | |
46 | ||
47 | /** | |
48 | * Github we're in. | |
49 | * @return Github | |
50 | */ | |
51 | Github github(); | |
52 | ||
53 | /** | |
54 | * Create a new gist. | |
55 | * | |
56 | * @param files Names and content of files | |
57 | * @param visible Indicates whether the gist is public | |
58 | * @return Gist | |
59 | * @throws IOException If there is any I/O problem | |
60 | * @see <a href="http://developer.github.com/v3/gists/#create-a-gist">Create a Gist</a> | |
61 | */ | |
62 | Gist create( | |
63 | Map<String, String> files, boolean visible | |
64 | ) throws IOException; | |
65 | ||
66 | /** | |
67 | * Get gist by name. | |
68 | * @param name Name of it | |
69 | * @return Gist | |
70 | * @see <a href="http://developer.github.com/v3/gists/#get-a-single-gist">Get a Single Gist</a> | |
71 | */ | |
72 | Gist get(String name); | |
73 | ||
74 | /** | |
75 | * Iterate all gists. | |
76 | * @return Iterator of gists | |
77 | * @see <a href="http://developer.github.com/v3/gists/#list-gists">List Gists</a> | |
78 | */ | |
79 | Iterable<Gist> iterate(); | |
80 | ||
81 | /** | |
82 | * Removes a gist by id. | |
83 | * | |
84 | * | |
85 | * @param identifier Identifier of the gist to be removed. | |
86 | * @throws IOException If there is any I/O problem | |
87 | */ | |
88 | void remove(String identifier) throws IOException; | |
89 | } |