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 com.jcabi.aspects.Loggable;
34 import java.io.IOException;
35 import javax.json.JsonObject;
36 import lombok.EqualsAndHashCode;
37 import lombok.ToString;
38
39 /**
40 * Github Git blob.
41 *
42 * @author Alexander Lukashevich (sanai56967@gmail.com)
43 * @version $Id: 1ce0be185b12b2b7bd5fdb6e233f6a5f76843864 $
44 * @see <a href="https://developer.github.com/v3/git/blobs/">Blobs API</a>
45 * @checkstyle MultipleStringLiterals (500 lines)
46 */
47 @Immutable
48 public interface Blob extends JsonReadable {
49 /**
50 * SHA of it.
51 * @return SHA
52 */
53 String sha();
54 /**
55 * Smart Blob with extra features.
56 */
57 @Immutable
58 @ToString
59 @Loggable(Loggable.DEBUG)
60 @EqualsAndHashCode(of = { "blob", "jsn" })
61 final class Smart implements Blob {
62 /**
63 * Encapsulated blob.
64 */
65 private final transient Blob blob;
66 /**
67 * SmartJson object for convenient JSON parsing.
68 */
69 private final transient SmartJson jsn;
70 /**
71 * Public ctor.
72 * @param blb Blob
73 */
74 public Smart(final Blob blb) {
75 this.blob = blb;
76 this.jsn = new SmartJson(blb);
77 }
78
79 @Override
80 public JsonObject json() throws IOException {
81 return this.blob.json();
82 }
83
84 @Override
85 public String sha() {
86 return this.blob.sha();
87 }
88
89 /**
90 * Get its url.
91 * @return Url of blob request
92 * @throws IOException If there is any I/O problem
93 */
94 public String url() throws IOException {
95 return this.jsn.text("url");
96 }
97 }
98 }