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 * Github users.
36 *
37 * @author Yegor Bugayenko (yegor256@gmail.com)
38 * @version $Id: ddb180db93f984cfdbf436392b60251f0fe89b23 $
39 * @since 0.1
40 * @see <a href="https://developer.github.com/v3/users/">Users API</a>
41 */
42 @Immutable
43 public interface Users {
44
45 /**
46 * Github we're in.
47 * @return Github
48 */
49 Github github();
50
51 /**
52 * Get myself.
53 * @return Myself
54 */
55 User self();
56
57 /**
58 * Get user by login.
59 * @param login Login of it
60 * @return User
61 * @see <a href="https://developer.github.com/v3/users/#get-a-single-user">Get a Single User</a>
62 */
63 User get(String login);
64
65 /**
66 * Add user by login and returns it.
67 * @param login Login of it
68 * @return Added user
69 */
70 User add(String login);
71
72 /**
73 * Iterate all users, starting with the one you've seen already.
74 * @param identifier The integer ID of the last User that you’ve seen.
75 * @return Iterator of gists
76 * @see <a href="https://developer.github.com/v3/users/#get-all-users">Get All Users</a>
77 */
78 Iterable<User> iterate(
79 String identifier
80 );
81
82 }