Interface ContentService.ContentFinder
-
- All Superinterfaces:
ContentService.ContentFetcher
,ContentService.ParameterContentFinder
,ContentService.SingleContentFetcher
,SingleFetcher<Content>
- All Known Implementing Classes:
NoopContentFinder
- Enclosing interface:
- ContentService
public static interface ContentService.ContentFinder extends ContentService.ParameterContentFinder
A finder for locating content
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContentService.SingleContentFetcher
withId(ContentId contentId)
Restrict the fetched content to that with the given ContentIdContentService.SingleContentFetcher
withIdAndVersion(ContentId contentId, int version)
Restrict the fetched content to that matching the given versionContentService.SingleContentFetcher
withLocator(ContentLocator locator)
Restrict the fetched content to that matching the given ContentLocator, a ContentLocator identifies a single piece of content.-
Methods inherited from interface com.atlassian.confluence.api.service.content.ContentService.ContentFetcher
fetchMany, fetchMappedByContentType
-
Methods inherited from interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder
withAnyStatus, withContainer, withCreatedDate, withId, withId, withSpace, withStatus, withStatus, withTitle, withType
-
Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher
fetch, fetchOne, fetchOneOrNull, fetchOrNull
-
-
-
-
Method Detail
-
withId
ContentService.SingleContentFetcher withId(ContentId contentId)
Restrict the fetched content to that with the given ContentId- Parameters:
contentId
- the id of the content to fetch- Returns:
- a SingleContentFetcher that will fetch a single piece of content if it exists
-
withIdAndVersion
ContentService.SingleContentFetcher withIdAndVersion(ContentId contentId, int version)
Restrict the fetched content to that matching the given version- Returns:
- a finder with the version restrictions applied
-
withLocator
ContentService.SingleContentFetcher withLocator(ContentLocator locator)
Restrict the fetched content to that matching the given ContentLocator, a ContentLocator identifies a single piece of content.- Parameters:
locator
- the content locator to use to find the content- Returns:
- a single content fetcher that fetches the content matched by the content locator
-
-