Coverage Report - com.jcabi.github.Users
 
Classes in this File Line Coverage Branch Coverage Complexity
Users
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright (c) 2013-2015, 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 javax.validation.constraints.NotNull;
 34  
 
 35  
 /**
 36  
  * Github users.
 37  
  *
 38  
  * @author Yegor Bugayenko (yegor@tpc2.com)
 39  
  * @version $Id$
 40  
  * @since 0.1
 41  
  * @see <a href="http://developer.github.com/v3/gists/">Gists API</a>
 42  
  */
 43  
 @Immutable
 44  
 public interface Users {
 45  
 
 46  
     /**
 47  
      * Github we're in.
 48  
      * @return Github
 49  
      */
 50  
     @NotNull(message = "Github is never NULL")
 51  
     Github github();
 52  
 
 53  
     /**
 54  
      * Get myself.
 55  
      * @return Myself
 56  
      */
 57  
     @NotNull(message = "user is never NULL")
 58  
     User self();
 59  
 
 60  
     /**
 61  
      * Get user by login.
 62  
      * @param login Login of it
 63  
      * @return User
 64  
      * @see <a href="http://developer.github.com/v3/users/#get-a-single-user">Get a Single User</a>
 65  
      */
 66  
     @NotNull(message = "user is never NULL")
 67  
     User get(@NotNull(message = "login is never NULL") String login);
 68  
 
 69  
     /**
 70  
      * Iterate all users, starting with the one you've seen already.
 71  
      * @param identifier The integer ID of the last User that you’ve seen.
 72  
      * @return Iterator of gists
 73  
      * @see <a href="http://developer.github.com/v3/users/#get-all-users">Get All Users</a>
 74  
      */
 75  
     @NotNull(message = "iterable is never NULL")
 76  
     Iterable<User> iterate(
 77  
         @NotNull(message = "identifier can't be NULL") String identifier
 78  
     );
 79  
 
 80  
 }