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 java.util.Map;
35
36 /**
37 * Github pull requests.
38 *
39 * @author Yegor Bugayenko (yegor256@gmail.com)
40 * @version $Id: 05dab664897c9af81d206cb04d6e45888984280e $
41 * @since 0.3
42 * @see <a href="https://developer.github.com/v3/pulls/">Pull Request API</a>
43 */
44 @Immutable
45 public interface Pulls {
46
47 /**
48 * Owner of them.
49 * @return Repo
50 */
51 Repo repo();
52
53 /**
54 * Get specific get by number.
55 * @param number Pull request number
56 * @return Pull request
57 * @see <a href="https://developer.github.com/v3/pulls/#get-a-single-pull-request">Get a Single Pull Request</a>
58 */
59 Pull get(int number);
60
61 /**
62 * Create new get.
63 * @param title Title
64 * @param head Head
65 * @param base Base
66 * @return Issue just created
67 * @throws IOException If there is any I/O problem
68 * @see <a href="https://developer.github.com/v3/pulls/#create-a-pull-request">Create a Pull Request</a>
69 */
70 Pull create(
71 String title,
72 String head,
73 String base)
74 throws IOException;
75
76 /**
77 * Iterate them all.
78 * @param params Params
79 * @return Iterator of issues
80 * @see <a href="https://developer.github.com/v3/pulls/#list-pull-requests">List Pull Requests</a>
81 */
82 Iterable<Pull> iterate(Map<String, String> params);
83
84 }