1 /**
2 * Copyright (c) 2013-2023, 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.Date;
35
36 /**
37 * Github comments.
38 *
39 * <p>Use this class to get access to all comments in an issue, for example:
40 *
41 * <pre> issue = // ... get it somewhere
42 * Comments comments = issue.comments();
43 * Comment comment = comments.post("Hi, how are you?");</pre>
44 *
45 * @author Yegor Bugayenko (yegor256@gmail.com)
46 * @version $Id: 33091c2d1e794aba94f885f0fcfc06ba935f3f87 $
47 * @since 0.1
48 * @see <a href="https://developer.github.com/v3/issues/comments/">Issue Comments API</a>
49 */
50 @Immutable
51 public interface Comments {
52
53 /**
54 * The issue we're in.
55 * @return Issue
56 */
57 Issue issue();
58
59 /**
60 * Get comment by number.
61 * @param number Comment number
62 * @return Comment
63 * @see <a href="https://developer.github.com/v3/issues/comments/#get-a-single-comment">Get a Single Comment</a>
64 */
65 Comment get(int number);
66
67 /**
68 * Iterate them all.
69 * @param since Since when? Just give {@code new Date(0)} if you want
70 * all comments.
71 * @return All comments
72 * @see <a href="https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue">List Comments on an Issue</a>
73 */
74 Iterable<Comment> iterate(Date since);
75
76 /**
77 * Post new comment.
78 * @param text Text of comment to post in Markdown format
79 * @return Comment
80 * @throws IOException If there is any I/O problem
81 * @see <a href="https://developer.github.com/v3/issues/comments/#create-a-comment">Create a Comment</a>
82 */
83 Comment post(String text) throws IOException;
84
85 }