com.atlassian.confluence.rest.client.remoteservice.lookandfeel.theme

Class RemoteThemeServiceImpl.RemoteThemeFinderImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<ThemeService.ThemeFinder>

com.atlassian.confluence.rest.client.remoteservice.lookandfeel.theme.RemoteThemeServiceImpl.RemoteThemeFinderImpl

All Implemented Interfaces:

RemoteManyFetcher<Theme>, RemoteThemeService.RemoteThemeFinder, RemoteSingleFetcher<Theme>

Enclosing class:

RemoteThemeServiceImpl

public class RemoteThemeServiceImpl.RemoteThemeFinderImpl
extends AbstractRemoteService<ThemeService.ThemeFinder>
implements RemoteThemeService.RemoteThemeFinder, RemoteSingleFetcher<Theme>

Field Summary

Fields inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

provider

Constructor Summary

Constructors

Constructor and Description
RemoteThemeFinderImpl(Expansion... expansions)

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<PageResponse<Theme>>	fetchMany(PageRequest request) Attempts to fetch a Page of Theme objects which match the filters specified.
com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Theme>>	fetchOne() Attempts to fetch a single Theme objects which matches the filters specified.
com.atlassian.util.concurrent.Promise<Theme>	fetchOneOrNull()
RemoteSingleFetcher<Theme>	globalTheme() Restrict the fetched Theme to be the one assigned globally.
RemoteSingleFetcher<Theme>	withSpace(String spaceKey) Restrict the fetched Theme to be the one assigned to a particular Space.
RemoteSingleFetcher<Theme>	withThemeKey(ThemeKey themeKey) Restrict the fetched Theme to be the one with specific key.
RemoteManyFetcher<Theme>	withThemeKey(ThemeKey themeKey, ThemeKey... moreThemeKeys) Restrict the fetched Themes to be the ones with the keys specified.

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteFuture, deleteFuture, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture, putFutureToPageResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteThemeFinderImpl

public RemoteThemeFinderImpl(Expansion... expansions)

Method Detail

withThemeKey

@Nonnull
public RemoteSingleFetcher<Theme> withThemeKey(ThemeKey themeKey)

Description copied from interface: RemoteThemeService.RemoteThemeFinder

Restrict the fetched Theme to be the one with specific key.

Specified by:

withThemeKey in interface RemoteThemeService.RemoteThemeFinder

Parameters:

themeKey - - the key of a Theme to be found.

Returns:

a fetcher with the filter applied.

withThemeKey

@Nonnull
public RemoteManyFetcher<Theme> withThemeKey(ThemeKey themeKey,
                                                      ThemeKey... moreThemeKeys)

Description copied from interface: RemoteThemeService.RemoteThemeFinder

Restrict the fetched Themes to be the ones with the keys specified.

Specified by:

withThemeKey in interface RemoteThemeService.RemoteThemeFinder

Parameters:

themeKey - - the key of a Theme to be found.

moreThemeKeys - - more theme keys

Returns:

a fetcher with the filter applied.

withSpace

@Nonnull
public RemoteSingleFetcher<Theme> withSpace(String spaceKey)

Description copied from interface: RemoteThemeService.RemoteThemeFinder

Restrict the fetched Theme to be the one assigned to a particular Space.

If there's no Theme explicitly assigned to a space then the RemoteThemeService.RemoteThemeFinder.fetchOne() method will throw NotFoundException.

Specified by:

withSpace in interface RemoteThemeService.RemoteThemeFinder

Parameters:

spaceKey - - the key of the Space to find the Theme for.

Returns:

a fetcher with the filter applied.

globalTheme

@Nonnull
public RemoteSingleFetcher<Theme> globalTheme()

Description copied from interface: RemoteThemeService.RemoteThemeFinder

Restrict the fetched Theme to be the one assigned globally.

If there's no Theme explicitly assigned globally, then the RemoteThemeService.RemoteThemeFinder.fetchOne() method will throw NotFoundException.

Specified by:

globalTheme in interface RemoteThemeService.RemoteThemeFinder

Returns:

a fetcher with the filter applied.

fetchOne

@Nonnull
public com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Theme>> fetchOne()
                                                                                           throws ServiceException

Description copied from interface: RemoteThemeService.RemoteThemeFinder

Attempts to fetch a single Theme objects which matches the filters specified.

Specified by:

fetchOne in interface RemoteThemeService.RemoteThemeFinder

Specified by:

fetchOne in interface RemoteSingleFetcher<Theme>

Returns:

Theme which matches the filter(s) specified or throws otherwise

Throws:

ServiceException

fetchOneOrNull

public com.atlassian.util.concurrent.Promise<Theme> fetchOneOrNull()

Specified by:

fetchOneOrNull in interface RemoteSingleFetcher<Theme>

fetchMany

@Nonnull
public com.atlassian.util.concurrent.Promise<PageResponse<Theme>> fetchMany(PageRequest request)
                                                                              throws ServiceException

Description copied from interface: RemoteThemeService.RemoteThemeFinder

Attempts to fetch a Page of Theme objects which match the filters specified. Won't accept null PageRequests

Specified by:

fetchMany in interface RemoteManyFetcher<Theme>

Specified by:

fetchMany in interface RemoteThemeService.RemoteThemeFinder

Parameters:

request - request specifying offset and limit for the desired page

Returns:

PageResponse (might be empty) of Theme objects corresponding to the filters specified or throws otherwise

Throws:

ServiceException