com.google.gerrit.server.account

Interface GroupMembership

All Known Implementing Classes:

IncludingGroupMembership, ListGroupMembership

public interface GroupMembership

Implementations of GroupMembership provide methods to test the presence of a user in a particular group.

Field Summary

Fields

Modifier and Type	Field and Description
static GroupMembership	EMPTY

Method Summary

Modifier and Type	Method and Description
boolean	contains(AccountGroup.UUID groupId) Returns true when the user this object was created for is a member of the specified group.
boolean	containsAnyOf(java.lang.Iterable<AccountGroup.UUID> groupIds) Returns true when the user this object was created for is a member of any of the specified group.
java.util.Set<AccountGroup.UUID>	getKnownGroups() Returns the set of groups that can be determined by the implementation.
java.util.Set<AccountGroup.UUID>	intersection(java.lang.Iterable<AccountGroup.UUID> groupIds) Returns a set containing an input member of contains(id) is true.

Field Detail

EMPTY

static final GroupMembership EMPTY

Method Detail

contains

boolean contains(AccountGroup.UUID groupId)

Returns true when the user this object was created for is a member of the specified group.

containsAnyOf

boolean containsAnyOf(java.lang.Iterable<AccountGroup.UUID> groupIds)

Returns true when the user this object was created for is a member of any of the specified group.

intersection

java.util.Set<AccountGroup.UUID> intersection(java.lang.Iterable<AccountGroup.UUID> groupIds)

Returns a set containing an input member of contains(id) is true.

This is batch form of contains that returns specific group information. Implementors may implement the method as:

 Set<AccountGroup.UUID> r = new HashSet<>();
 for (AccountGroup.UUID id : groupIds)
   if (contains(id)) r.add(id);
 

getKnownGroups

java.util.Set<AccountGroup.UUID> getKnownGroups()

Returns the set of groups that can be determined by the implementation. This may not return all groups the contains(AccountGroup.UUID) would return true for, but will at least contain all top level groups. This restriction stems from the API of some group systems, which make it expensive to enumerate the members of a group.