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 forks.
37 *
38 * @author Carlos Miranda (miranda.cma@gmail.com)
39 * @version $Id: 245d450fce0979d867dc370e7dc811d959813c5f $
40 * @since 0.8
41 * @see <a href="https://developer.github.com/v3/repos/forks/">Forks API</a>
42 */
43 @Immutable
44 public interface Forks {
45
46 /**
47 * Owner of them.
48 * @return Repo
49 */
50 Repo repo();
51
52 /**
53 * Iterate all forks.
54 *
55 * @param sort The sort order.
56 * @return All forks
57 * @see <a href="https://developer.github.com/v3/repos/forks/#list-forks">List forks</a>
58 */
59 Iterable<Fork> iterate(String sort);
60
61 /**
62 * Create a fork for the authenticated user.
63 *
64 * @param organization The organization the repository will be forked into.
65 * @return The new fork
66 * @throws IOException If there is any I/O problem
67 * @see <a href="https://developer.github.com/v3/repos/forks/#create-a-fork">Create a fork</a>
68 */
69 Fork create(String organization) throws IOException;
70 }