Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Collaborators |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright (c) 2013-2017, 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 | ||
31 | package com.jcabi.github; | |
32 | ||
33 | import com.jcabi.aspects.Immutable; | |
34 | import java.io.IOException; | |
35 | ||
36 | /** | |
37 | * Github repository collaborators. | |
38 | * @author Aleksey Popov (alopen@yandex.ru) | |
39 | * @version $Id: df8e4e273d8c3f4a12c29c3540875711eb2d8625 $ | |
40 | * @since 0.8 | |
41 | */ | |
42 | @Immutable | |
43 | public interface Collaborators { | |
44 | /** | |
45 | * Owner of them. | |
46 | * @return Repo | |
47 | */ | |
48 | Repo repo(); | |
49 | ||
50 | /** | |
51 | * Check if a user is collaborator. | |
52 | * | |
53 | * @param user User | |
54 | * @return True is a user is a collaborator, otherwise returns false | |
55 | * @throws IOException If there is any I/O problem | |
56 | * @see <a href="http://developer.github.com/v3/repos/collaborators/#get"> | |
57 | * Check if a user is collaborator</a> | |
58 | */ | |
59 | boolean isCollaborator(String user) throws IOException; | |
60 | ||
61 | /** | |
62 | * Add user as a collaborator. | |
63 | * | |
64 | * @param user User | |
65 | * @throws IOException If there is any I/O problem | |
66 | * @see <a href="http://developer.github.com/v3/repos/collaborators/#add-collaborator">Add user as a collaborator</a> | |
67 | */ | |
68 | void add(String user) throws IOException; | |
69 | ||
70 | /** | |
71 | * Remove user as a collaborator. | |
72 | * | |
73 | * @param user User | |
74 | * @throws IOException If there is any I/O problem | |
75 | * @see <a href="http://developer.github.com/v3/repos/collaborators/#remove-collaborator">Remove user as a collaborator</a> | |
76 | */ | |
77 | void remove(String user) throws IOException; | |
78 | ||
79 | /** | |
80 | * Iterates over repo collaborators. | |
81 | * @return Iterator on repo collaborators. | |
82 | */ | |
83 | Iterable<User> iterate(); | |
84 | } |