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 javax.json.JsonObject;
35
36 /**
37 * Github Git Data Commits.
38 *
39 * @author Carlos Miranda (miranda.cma@gmail.com)
40 * @version $Id: 762676e2c0c6890ae1d68ca0658a70d4162cf594 $
41 * @since 0.8
42 * @see <a href="https://developer.github.com/v3/git/commits/">Commits API</a>
43 */
44 @Immutable
45 public interface Commits {
46
47 /**
48 * Owner of them.
49 * @return Repo
50 */
51 Repo repo();
52
53 /**
54 * Create a Commit object.
55 * @param params The input for creating the Tag.
56 * @return Commit
57 * @throws IOException - If anything goes wrong.
58 */
59 Commit create(JsonObject params) throws IOException;
60
61 /**
62 * Return a Commit by its SHA.
63 * @param sha The sha of the Commit.
64 * @return Commit
65 */
66 Commit get(String sha);
67
68 /**
69 * Return a Statuses object for a given ref (sha, branch name, etc).
70 * @param ref The ref of the Commit
71 * @since 0.23
72 * @return Status
73 */
74 Statuses statuses(final String ref);
75 }