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
34 /**
35 * Git branches.
36 *
37 * @author Chris Rebert (github@rebertia.com)
38 * @version $Id: 76586c86070208bad22b445b01e64d273dc12dd1 $
39 * @since 0.24
40 * @see <a href="https://developer.github.com/v3/repos/#list-branches">List Branches API</a>
41 */
42 @Immutable
43 public interface Branches {
44 /**
45 * Repo which the branches are in.
46 * @return Repo
47 */
48 Repo repo();
49
50 /**
51 * Iterate over all branches in the repo.
52 * @return Iterator of branches
53 * @see <a href="https://developer.github.com/v3/repos/#list-branches">List Branches API</a>
54 */
55 Iterable<Branch> iterate();
56
57 /**
58 * Find branches by name.
59 * @param name The name of the branch.
60 * @return Branch found by name
61 * @see <a href="https://developer.github.com/v3/repos/branches/#get-branch">Get Branch API</a>
62 */
63 Branch find(String name);
64 }