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

Class PersonServiceImpl.PersonFinderImpl

java.lang.Object

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

com.atlassian.confluence.api.impl.service.people.PersonServiceImpl.PersonFinderImpl

All Implemented Interfaces:

ManyFetcher<Person>, SingleFetcher<Person>, PersonService.PersonFinder, PersonService.SinglePersonFetcher

Enclosing class:

PersonServiceImpl

public class PersonServiceImpl.PersonFinderImpl
extends AbstractFinder<Person>
implements PersonService.PersonFinder

Field Summary

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

expansions

Constructor Summary

Constructors

Constructor	Description
PersonFinderImpl(Expansion... expansions)

Method Summary

Modifier and Type	Method	Description
Optional<Person>	fetch()
PageResponse<Person>	fetchMany(PageRequest request)
PersonService.PersonFinder	withMembershipOf(Group group)	Restrict the finder to just users that are members of the given group
PersonService.PersonFinder	withUserKey(com.atlassian.sal.api.user.UserKey userKey)	Restrict the finder to just the user with the given userKey
PersonService.PersonFinder	withUsername(String username)	Restrict the finder to just user with the given username

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

fetchOneOrNull, 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

fetchOne, fetchOneOrNull, fetchOrNull

Constructor Detail

PersonFinderImpl

public PersonFinderImpl(Expansion... expansions)

Method Detail

withUserKey

public PersonService.PersonFinder withUserKey(com.atlassian.sal.api.user.UserKey userKey)

Description copied from interface: PersonService.PersonFinder

Restrict the finder to just the user with the given userKey

Specified by:

withUserKey in interface PersonService.PersonFinder

Returns:

this

withUsername

public PersonService.PersonFinder withUsername(String username)

Description copied from interface: PersonService.PersonFinder

Restrict the finder to just user with the given username

Specified by:

withUsername in interface PersonService.PersonFinder

Returns:

this

withMembershipOf

public PersonService.PersonFinder withMembershipOf(Group group)

Description copied from interface: PersonService.PersonFinder

Restrict the finder to just users that are members of the given group

Specified by:

withMembershipOf in interface PersonService.PersonFinder

Returns:

this

fetchMany

public PageResponse<Person> fetchMany(PageRequest request)

Specified by:

fetchMany in interface ManyFetcher<Person>

Parameters:

request - - 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

fetch

public Optional<Person> fetch()

Specified by:

fetch in interface SingleFetcher<Person>