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 hook.
41 *
42 * @author Paul Polishchuk (ppol@ua.fm)
43 * @version $Id: 99099d9d12c6f80f7ed353e90d74bb9eba8cb3dc $
44 * @since 0.8
45 * @see <a href="https://developer.github.com/v3/repos/hooks/">Hooks API</a>
46 */
47 @Immutable
48 public interface Hook extends JsonReadable {
49
50 /**
51 * Repository we're in.
52 * @return Repo
53 */
54 Repo repo();
55
56 /**
57 * Get its number.
58 * @return Hook number
59 */
60 int number();
61
62 /**
63 * Smart Hook with extra features.
64 */
65 @Immutable
66 @ToString
67 @Loggable(Loggable.DEBUG)
68 @EqualsAndHashCode(of = { "hook", "jsn" })
69 final class Smart implements Hook {
70 /**
71 * Encapsulated Hook.
72 */
73 private final transient Hook hook;
74 /**
75 * SmartJson object for convenient JSON parsing.
76 */
77 private final transient SmartJson jsn;
78 /**
79 * Public ctor.
80 * @param hoo Hook
81 */
82 public Smart(final Hook hoo) {
83 this.hook = hoo;
84 this.jsn = new SmartJson(hoo);
85 }
86 /**
87 * Get its name.
88 * @return Name of hook
89 * @throws IOException If there is any I/O problem
90 */
91 public String name() throws IOException {
92 return this.jsn.text("name");
93 }
94 @Override
95 public Repo repo() {
96 return this.hook.repo();
97 }
98 @Override
99 public int number() {
100 return this.hook.number();
101 }
102 @Override
103 public JsonObject json() throws IOException {
104 return this.hook.json();
105 }
106 }
107 }