Coverage Report - com.jcabi.github.Organizations
 
Classes in this File Line Coverage Branch Coverage Complexity
Organizations
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 organizations.
 37  
  * @author Paul Polishchuk (ppol@ua.fm)
 38  
  * @version $Id$
 39  
  * @see <a href="http://developer.github.com/v3/orgs/">Organizations API</a>
 40  
  * @since 0.7
 41  
  */
 42  
 @Immutable
 43  
 public interface Organizations {
 44  
 
 45  
     /**
 46  
      * Github we're in.
 47  
      * @return Github
 48  
      */
 49  
     @NotNull(message = "Github is never NULL")
 50  
     Github github();
 51  
 
 52  
     /**
 53  
      * Get its owner.
 54  
      * @return User
 55  
      */
 56  
     @NotNull(message = "user is never NULL")
 57  
     User user();
 58  
 
 59  
     /**
 60  
      * Get specific organization by name.
 61  
      * @param login Login name of the organization.
 62  
      * @return Organization
 63  
      * @see <a href="http://developer.github.com/v3/orgs/#get-an-organization">Get a Single Organization</a>
 64  
      */
 65  
     @NotNull(message = "organization is never NULL")
 66  
     Organization get(@NotNull(message = "login is never NULL") String login);
 67  
 
 68  
     /**
 69  
      * Iterate them all.
 70  
      * @return Iterator of Organizations
 71  
      * @see <a href="http://developer.github.com/v3/orgs/#list-user-organizations">List Organizations</a>
 72  
      */
 73  
     @NotNull(message = "iterable is never NULL")
 74  
     Iterable<Organization> iterate();
 75  
 
 76  
     /**
 77  
      * Iterate organizations of particular user.
 78  
      * All public organizations for an unauthenticated user or
 79  
      * private and public organizations for authenticated users
 80  
      * @param username Name of user
 81  
      * @return Iterator of Organizations
 82  
      * @see <a href="http://developer.github.com/v3/orgs/#list-user-organizations">List Organizations</a>
 83  
      * @since 0.8
 84  
      */
 85  
     @NotNull(message = "iterable is never NULL")
 86  
     Iterable<Organization> iterate(
 87  
         @NotNull(message = "username is never NULL") String username
 88  
     );
 89  
 }