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