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
35 /**
36 * Github Git.
37 *
38 * @author Carlos Miranda (miranda.cma@gmail.com)
39 * @version $Id: daf4f4ae3515a3d7b021eb429da660cf057cb59e $
40 * @since 0.8
41 */
42 @Immutable
43 public interface Git {
44
45 /**
46 * Owner of it.
47 * @return Repo
48 */
49 Repo repo();
50
51 /**
52 * Get its blobs.
53 * @return Blobs
54 * @see <a href="https://developer.github.com/v3/git/blobs/">Blobs API</a>
55 * @throws IOException If some io problem occurs
56 */
57 Blobs blobs() throws IOException;
58
59 /**
60 * Get its commits.
61 * @return Commits
62 * @see <a href="https://developer.github.com/v3/git/commits/">Commits API</a>
63 */
64 Commits commits();
65
66 /**
67 * Get its references.
68 * @return References
69 * @see <a href="https://developer.github.com/v3/git/references/">References API</a>
70 */
71 References references();
72
73 /**
74 * Get its tags.
75 * @return Tags
76 * @see <a href="https://developer.github.com/v3/git/tags/">Tags API</a>
77 */
78 Tags tags();
79
80 /**
81 * Get its trees.
82 * @return Trees
83 * @see <a href="https://developer.github.com/v3/git/trees/">Trees API</a>
84 */
85 Trees trees();
86 }