com.jcabi.github

Class RtPublicMembers

java.lang.Object

com.jcabi.github.RtPublicMembers

All Implemented Interfaces:

PublicMembers

@Immutable
 @Loggable(value=1)
public final class RtPublicMembers
extends Object
implements PublicMembers

Public members of a GitHub organization.

Since:

0.24

Version:

$Id: 7d246ede5f0adeed244dd3b741e9fb0dbddb38fc $

Author:

Chris Rebert (github@chrisrebert.com)

See Also:

Organization Members API

Constructor Summary

Constructors

Constructor and Description
RtPublicMembers(com.jcabi.http.Request req, Organization organ) Public ctor.

Method Summary

Modifier and Type	Method and Description
void	conceal(User user) Conceal a user's membership from public view.
boolean	contains(User user) Check whether the user is a public member of this organization.
Iterable<User>	iterate() Get all users who are public members of this organization.
Organization	org() Organization of which these are public members.
void	publicize(User user) Make a user's membership publicly visible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RtPublicMembers

public RtPublicMembers(com.jcabi.http.Request req,
                       Organization organ)

Public ctor.

Parameters:

req - Request

organ - Organization

Method Detail

org

public Organization org()

Description copied from interface: PublicMembers

Organization of which these are public members.

Specified by:

org in interface PublicMembers

Returns:

Organization

conceal

public void conceal(User user)
             throws IOException

Description copied from interface: PublicMembers

Conceal a user's membership from public view.

Specified by:

conceal in interface PublicMembers

Parameters:

user - User whose membership to conceal

Throws:

IOException - If an I/O problem occurs

See Also:

Conceal a user's membership

publicize

public void publicize(User user)
               throws IOException

Description copied from interface: PublicMembers

Make a user's membership publicly visible.

Specified by:

publicize in interface PublicMembers

Parameters:

user - User whose membership to publicize

Throws:

IOException - If an I/O problem occurs

See Also:

Publicize a user's membership

iterate

public Iterable<User> iterate()

Description copied from interface: PublicMembers

Get all users who are public members of this organization.

Specified by:

iterate in interface PublicMembers

Returns:

Members

See Also:

Public members list

contains

public boolean contains(User user)
                 throws IOException

Description copied from interface: PublicMembers

Check whether the user is a public member of this organization.

Specified by:

contains in interface PublicMembers

Parameters:

user - User to check public organization membership of

Returns:

Is the user a public member of this organization?

Throws:

IOException - If an I/O problem occurs

See Also:

Check public membership