Coverage Report

Coverage Report - com.jcabi.github.PublicMembers

Classes in this File

 /**
  * Copyright (c) 2013-2017, jcabi.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met: 1) Redistributions of source code must retain the above
  * copyright notice, this list of conditions and the following
  * disclaimer. 2) Redistributions in binary form must reproduce the above
  * copyright notice, this list of conditions and the following
  * disclaimer in the documentation and/or other materials provided
  * with the distribution. 3) Neither the name of the jcabi.com nor
  * the names of its contributors may be used to endorse or promote
  * products derived from this software without specific prior written
  * permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.jcabi.github;
 
 import com.jcabi.aspects.Immutable;
 import java.io.IOException;
 
 /**
  * Public members of a GitHub organization.
  *
  * @author Chris Rebert (github@chrisrebert.com)
  * @version $Id: bff610dd8bb68f9a57090b3208652889d38edf7b $
  * @see <a href="https://developer.github.com/v3/orgs/members/">Organization Members API</a>
  * @since 0.24
  */
 @Immutable
 public interface PublicMembers {
     /**
      * Organization of which these are public members.
      * @return Organization
      */
     Organization org();
 
     /**
      * Conceal a user's membership from public view.
      * @param user User whose membership to conceal
      * @throws IOException If an I/O problem occurs
      * @see <a href="https://developer.github.com/v3/orgs/members/#conceal-a-users-membership">Conceal a user's membership</a>
      */
     void conceal(
         User user
     ) throws IOException;
 
     /**
      * Make a user's membership publicly visible.
      * @param user User whose membership to publicize
      * @throws IOException If an I/O problem occurs
      * @see <a href="https://developer.github.com/v3/orgs/members/#publicize-a-users-membership">Publicize a user's membership</a>
      */
     void publicize(
         User user
     ) throws IOException;
 
     /**
      * Get all users who are public members of this organization.
      * @return Members
      * @see <a href="https://developer.github.com/v3/orgs/members/#public-members-list">Public members list</a>
      */
     Iterable<User> iterate();
 
     /**
      * Check whether the user is a public member of this organization.
      * @param user User to check public organization membership of
      * @return Is the user a public member of this organization?
      * @throws IOException If an I/O problem occurs
      * @see <a href="https://developer.github.com/v3/orgs/members/#check-public-membership">Check public membership</a>
      */
     boolean contains(
         User user
     ) throws IOException;
 }

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		package com.jcabi.github;
31
32		import com.jcabi.aspects.Immutable;
33		import java.io.IOException;
34
35		/**
36		* Public members of a GitHub organization.
37		*
38		* @author Chris Rebert (github@chrisrebert.com)
39		* @version $Id: bff610dd8bb68f9a57090b3208652889d38edf7b $
40		* @see <a href="https://developer.github.com/v3/orgs/members/">Organization Members API</a>
41		* @since 0.24
42		*/
43		@Immutable
44		public interface PublicMembers {
45		/**
46		* Organization of which these are public members.
47		* @return Organization
48		*/
49		Organization org();
50
51		/**
52		* Conceal a user's membership from public view.
53		* @param user User whose membership to conceal
54		* @throws IOException If an I/O problem occurs
55		* @see <a href="https://developer.github.com/v3/orgs/members/#conceal-a-users-membership">Conceal a user's membership</a>
56		*/
57		void conceal(
58		User user
59		) throws IOException;
60
61		/**
62		* Make a user's membership publicly visible.
63		* @param user User whose membership to publicize
64		* @throws IOException If an I/O problem occurs
65		* @see <a href="https://developer.github.com/v3/orgs/members/#publicize-a-users-membership">Publicize a user's membership</a>
66		*/
67		void publicize(
68		User user
69		) throws IOException;
70
71		/**
72		* Get all users who are public members of this organization.
73		* @return Members
74		* @see <a href="https://developer.github.com/v3/orgs/members/#public-members-list">Public members list</a>
75		*/
76		Iterable<User> iterate();
77
78		/**
79		* Check whether the user is a public member of this organization.
80		* @param user User to check public organization membership of
81		* @return Is the user a public member of this organization?
82		* @throws IOException If an I/O problem occurs
83		* @see <a href="https://developer.github.com/v3/orgs/members/#check-public-membership">Check public membership</a>
84		*/
85		boolean contains(
86		User user
87		) throws IOException;
88		}