com.atlassian.confluence.api.impl.service.lookandfeel.theme

Class ThemeServiceImpl.ThemeFinderImpl

java.lang.Object

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

com.atlassian.confluence.api.impl.service.lookandfeel.theme.ThemeServiceImpl.ThemeFinderImpl

All Implemented Interfaces:

ManyFetcher<Theme>, SingleFetcher<Theme>, ThemeService.ThemeFinder

Enclosing class:

ThemeServiceImpl

public class ThemeServiceImpl.ThemeFinderImpl
extends AbstractFinder<Theme>
implements ThemeService.ThemeFinder

Field Summary

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

expansions

Constructor Summary

Constructors

Constructor and Description
ThemeFinderImpl(Expansion... expansions)

Method Summary

Modifier and Type	Method and Description
PageResponse<Theme>	fetchMany(PageRequest request)
com.atlassian.fugue.Option<Theme>	fetchOne()
SingleFetcher<Theme>	globalTheme() Restrict the fetched Theme to be the one assigned globally.
SingleFetcher<Theme>	withSpace(String spaceKey) Restrict the fetched Theme to be the one assigned to a particular Space.
SingleFetcher<Theme>	withThemeKey(ThemeKey themeKey) Restrict the fetched Theme to be the one with specific key.
ManyFetcher<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.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

fetchOneOrNull

Constructor Detail

ThemeFinderImpl

public ThemeFinderImpl(Expansion... expansions)

Method Detail

withThemeKey

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

Description copied from interface: ThemeService.ThemeFinder

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

Specified by:

withThemeKey in interface ThemeService.ThemeFinder

Parameters:

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

Returns:

a fetcher with the filter applied.

withThemeKey

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

Description copied from interface: ThemeService.ThemeFinder

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

Specified by:

withThemeKey in interface ThemeService.ThemeFinder

Parameters:

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

moreThemeKeys - - more theme keys

Returns:

a fetcher with the filter applied.

withSpace

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

Description copied from interface: ThemeService.ThemeFinder

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 SingleFetcher.fetchOne() method will throw NotFoundException.

Specified by:

withSpace in interface ThemeService.ThemeFinder

Parameters:

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

Returns:

a fetcher with the filter applied.

globalTheme

@Nonnull
public SingleFetcher<Theme> globalTheme()

Description copied from interface: ThemeService.ThemeFinder

Restrict the fetched Theme to be the one assigned globally.

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

Specified by:

globalTheme in interface ThemeService.ThemeFinder

Returns:

a fetcher with the filter applied.

fetchOne

@Nonnull
public com.atlassian.fugue.Option<Theme> fetchOne()

Specified by:

fetchOne in interface SingleFetcher<Theme>

fetchMany

@Nonnull
public PageResponse<Theme> fetchMany(PageRequest request)

Specified by:

fetchMany in interface ManyFetcher<Theme>

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