Package com.atlassian.confluence.api.impl.service.people

Class GroupServiceImpl.GroupFinderImpl

java.lang.Object

com.atlassian.confluence.api.impl.service.content.finder.AbstractFinder<Group>

com.atlassian.confluence.api.impl.service.people.GroupServiceImpl.GroupFinderImpl

All Implemented Interfaces:

ManyFetcher<Group>, SingleFetcher<Group>, GroupService.GroupFinder

Enclosing class:

GroupServiceImpl

public class GroupServiceImpl.GroupFinderImpl
extends AbstractFinder<Group>
implements GroupService.GroupFinder

Field Summary

Fields inherited from class com.atlassian.confluence.api.impl.service.content.finder.AbstractFinder

expansions

Constructor Summary

Constructors

Constructor	Description
GroupFinderImpl(Expansion[] expansions)

Method Summary

Modifier and Type	Method	Description
Optional<Group>	fetch()
PageResponse<Group>	fetchMany(PageRequest pageRequest)
GroupService.GroupFinder	withAncestorOf(Group group)	Restrict the finder to find groups that are ancestor of the given group
GroupService.GroupFinder	withMember(User person)	Filter to groups that have the given person as a member
GroupService.GroupFinder	withMembershipOf(Group group)	Restrict the finder to find groups that are members of the given group
GroupService.GroupFinder	withName(String groupName)	Restrict the fetched group to matching the given groupName
GroupService.GroupFinder	withParentOf(Group group)	Restrict the finder to find groups that are parents of the given group

Methods inherited from class com.atlassian.confluence.api.impl.service.content.finder.AbstractFinder

getExpansions

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetchOneOrNull, fetchOrNull

Constructor Details

GroupFinderImpl

public GroupFinderImpl(Expansion[] expansions)

Method Details

fetchMany

public PageResponse<Group> fetchMany(PageRequest pageRequest)

Specified by:

fetchMany in interface ManyFetcher<Group>

Parameters:

pageRequest - - a pageRequest to use to paginate the response, this will be limited if it exceeds system limits

Returns:

a pageResponse of given type that matches the given restrictions

withName

public GroupService.GroupFinder withName(String groupName)

Description copied from interface: GroupService.GroupFinder

Restrict the fetched group to matching the given groupName

Specified by:

withName in interface GroupService.GroupFinder

Parameters:

groupName - the name of the group to match

Returns:

a fetcher with the filter applied.

withMember

public GroupService.GroupFinder withMember(User person)

Description copied from interface: GroupService.GroupFinder

Filter to groups that have the given person as a member

Specified by:

withMember in interface GroupService.GroupFinder

Returns:

this

withMembershipOf

public GroupService.GroupFinder withMembershipOf(Group group)

Description copied from interface: GroupService.GroupFinder

Restrict the finder to find groups that are members of the given group

Specified by:

withMembershipOf in interface GroupService.GroupFinder

Returns:

this

withParentOf

public GroupService.GroupFinder withParentOf(Group group)

Description copied from interface: GroupService.GroupFinder

Restrict the finder to find groups that are parents of the given group

Specified by:

withParentOf in interface GroupService.GroupFinder

Returns:

this

withAncestorOf

public GroupService.GroupFinder withAncestorOf(Group group)

Description copied from interface: GroupService.GroupFinder

Restrict the finder to find groups that are ancestor of the given group

Specified by:

withAncestorOf in interface GroupService.GroupFinder

Returns:

this

fetch

public Optional<Group> fetch()

Specified by:

fetch in interface SingleFetcher<Group>