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 Data Blobs.
37 *
38 * @author Carlos Miranda (miranda.cma@gmail.com)
39 * @version $Id: 77c98da6cb9aa994b88ec39da0e3daf334d52f9d $
40 * @since 0.8
41 * @see <a href="https://developer.github.com/v3/git/blobs/">Blobs API</a>
42 */
43 @Immutable
44 public interface Blobs {
45
46 /**
47 * Owner of them.
48 * @return Repo
49 */
50 Repo repo();
51
52 /**
53 * Get specific blob by sha.
54 * @param sha SHA of a blob
55 * @return Blob
56 * @see <a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get single blob</a>
57 */
58 Blob get(String sha);
59
60 /**
61 * Create a blob.
62 * @param content Content
63 * @param encoding Encoding
64 * @return A new blob
65 * @throws IOException If there is any I/O problem
66 * @see <a href="https://developer.github.com/v3/git/blobs/#create-a-blob">Create a Blob</a>
67 */
68 Blob create(String content, String encoding) throws IOException;
69
70 }