| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| GistComments |
|
| 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 | * Gist Comments. | |
| 37 | * | |
| 38 | * <p>Use this class to get access to all comments in a gist, for example: | |
| 39 | * | |
| 40 | * <pre> gist = // ... get it somewhere | |
| 41 | * GistComments comments = gist.comments(); | |
| 42 | * GistComment comment = comments.post("Hi, how are you?");</pre> | |
| 43 | * | |
| 44 | * @author Giang Le (giang@vn-smartsolutions.com) | |
| 45 | * @version $Id: 257cbceb8b14174eaf9bd773ad0aa919e80c611c $ | |
| 46 | * @since 0.8 | |
| 47 | * @see <a href="http://developer.github.com/v3/gists/comments/">Gist Comments API</a> | |
| 48 | */ | |
| 49 | @Immutable | |
| 50 | public interface GistComments { | |
| 51 | /** | |
| 52 | * The gist we're in. | |
| 53 | * @return Issue | |
| 54 | */ | |
| 55 | Gist gist(); | |
| 56 | ||
| 57 | /** | |
| 58 | * Get comment by number. | |
| 59 | * @param number Comment number | |
| 60 | * @return Comment | |
| 61 | * @see <a href="http://developer.github.com/v3/gists/comments/#get-a-single-comment">Get a Single Comment</a> | |
| 62 | */ | |
| 63 | GistComment get(int number); | |
| 64 | ||
| 65 | /** | |
| 66 | * Iterate them all. | |
| 67 | * @return All comments | |
| 68 | * @see <a href="http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist">List Comments on an Gist</a> | |
| 69 | */ | |
| 70 | Iterable<GistComment> iterate(); | |
| 71 | ||
| 72 | /** | |
| 73 | * Post new comment. | |
| 74 | * @param text Text of comment to post in Markdown format | |
| 75 | * @return Comment | |
| 76 | * @throws IOException If there is any I/O problem | |
| 77 | * @see <a href="http://developer.github.com/v3/gists/comments/#create-a-comment">Create a Comment</a> | |
| 78 | */ | |
| 79 | GistComment post(String text) | |
| 80 | throws IOException; | |
| 81 | } |