Package com.atlassian.confluence.impl.service.finder.content

Class NoopContentFinder

java.lang.Object

com.atlassian.confluence.impl.service.finder.NoopFetcher<Content>

com.atlassian.confluence.impl.service.finder.content.NoopContentFinder

All Implemented Interfaces:

ContentService.ContentFetcher, ContentService.ContentFinder, ContentService.ParameterContentFinder, ContentService.SingleContentFetcher, ManyFetcher<Content>, SingleFetcher<Content>

public class NoopContentFinder
extends NoopFetcher<Content>
implements ContentService.ContentFinder

Since:

6.13.6, 6.14.4, 6.15.4

Constructor Summary

Constructors

Constructor	Description
NoopContentFinder()

Method Summary

Modifier and Type	Method	Description
boolean	canExpand(String expansion)
PageResponse<Content>	fetchMany(ContentType type, PageRequest request)
PageResponse<Content>	fetchManyWithAnyType(PageRequest request)
PageResponse<Content>	fetchManyWithoutCaching(ContentType type, PageRequest request)
Map<ContentType,PageResponse<Content>>	fetchMappedByContentType(PageRequest request)
ContentService.ContentFinder	withAnyStatus()	Don't restrict the fetched content on status.
ContentService.ParameterContentFinder	withContainer(Container container)	Restrict the fetched content to those with the given Container, this will by proxy restrict to certain types of content, as different types of content can have different types of containers.
ContentService.ParameterContentFinder	withCreatedDate(LocalDate time)	Restrict the fetched content to those created / published on the given date
ContentService.SingleContentFetcher	withId(ContentId contentId)	Restrict the fetched content to that with the given ContentId
ContentService.ParameterContentFinder	withId(ContentId first, ContentId... tail)	Restrict the fetched content to those with the given ids, requires at least two ContentIds.
ContentService.ParameterContentFinder	withId(Iterable<ContentId> contentIds)	Restrict the fetched content to those with the given ids
ContentService.SingleContentFetcher	withIdAndVersion(ContentId contentId, int version)	Restrict the fetched content to that matching the given version
ContentService.SingleContentFetcher	withLocator(ContentLocator locator)	Restrict the fetched content to that matching the given ContentLocator, a ContentLocator identifies a single piece of content.
ContentService.ParameterContentFinder	withSpace(Space... space)	Restrict the fetched content to those in the given spaces.
ContentService.ContentFinder	withStatus(ContentStatus... status)	Restrict the fetched content to that matching the given statuses.
ContentService.ContentFinder	withStatus(Iterable<ContentStatus> statuses)	Restrict the fetched content to that matching the given statuses.
ContentService.ParameterContentFinder	withTitle(String title)	Restrict the fetched content to those with the given title
ContentService.ParameterContentFinder	withType(ContentType... type)	Restrict the fetched content to those matching the given contentType

Methods inherited from class com.atlassian.confluence.impl.service.finder.NoopFetcher

fetch, fetchMany

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

fetch, fetchOneOrNull, fetchOrNull

Constructor Details

NoopContentFinder

public NoopContentFinder()

Method Details

canExpand

public boolean canExpand(String expansion)

Specified by:

canExpand in interface ContentService.ContentFinder

Parameters:

expansion - the expansion to check

Returns:

true if the finder can expand the property

withId

public ContentService.SingleContentFetcher withId(ContentId contentId)

Description copied from interface: ContentService.ContentFinder

Restrict the fetched content to that with the given ContentId

Specified by:

withId in interface ContentService.ContentFinder

Parameters:

contentId - the id of the content to fetch

Returns:

a SingleContentFetcher that will fetch a single piece of content if it exists

withIdAndVersion

public ContentService.SingleContentFetcher withIdAndVersion(ContentId contentId,
 int version)

Description copied from interface: ContentService.ContentFinder

Restrict the fetched content to that matching the given version

Specified by:

withIdAndVersion in interface ContentService.ContentFinder

Returns:

a finder with the version restrictions applied

withLocator

public ContentService.SingleContentFetcher withLocator(ContentLocator locator)

Description copied from interface: ContentService.ContentFinder

Restrict the fetched content to that matching the given ContentLocator, a ContentLocator identifies a single piece of content.

Specified by:

withLocator in interface ContentService.ContentFinder

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

withSpace

public ContentService.ParameterContentFinder withSpace(Space... space)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those in the given spaces.

Currently only fetching by a single space is supported

Specified by:

withSpace in interface ContentService.ParameterContentFinder

Parameters:

space - the spaces to restrict the found content to

Returns:

this ContentFinder with the space restriction applied

withType

public ContentService.ParameterContentFinder withType(ContentType... type)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those matching the given contentType

Specified by:

withType in interface ContentService.ParameterContentFinder

Parameters:

type - - the contentType to restrict to

Returns:

this ContentFinder with the contentType restriction applied

withCreatedDate

public ContentService.ParameterContentFinder withCreatedDate(LocalDate time)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those created / published on the given date

Specified by:

withCreatedDate in interface ContentService.ParameterContentFinder

Parameters:

time - - the publish date to restrict the content

Returns:

this ContentFinder with the creation date restriction applied

withTitle

public ContentService.ParameterContentFinder withTitle(String title)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those with the given title

Specified by:

withTitle in interface ContentService.ParameterContentFinder

Parameters:

title - the title to restrict the content to

Returns:

this ContentFinder with the title restriction applied

withContainer

public ContentService.ParameterContentFinder withContainer(Container container)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those with the given Container, this will by proxy restrict to certain types of content, as different types of content can have different types of containers.

Specified by:

withContainer in interface ContentService.ParameterContentFinder

Parameters:

container - the container to restrict the content to

Returns:

this ContentFinder with the container restriction applied

withId

public ContentService.ParameterContentFinder withId(ContentId first,
 ContentId... tail)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those with the given ids, requires at least two ContentIds.

Specified by:

withId in interface ContentService.ParameterContentFinder

Returns:

this ContentFinder with the restrictions applied

withId

public ContentService.ParameterContentFinder withId(Iterable<ContentId> contentIds)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to those with the given ids

Specified by:

withId in interface ContentService.ParameterContentFinder

Parameters:

contentIds - - the list of contentIds to restrict to

Returns:

this ContentFinder with the restrictions applied

withStatus

public ContentService.ContentFinder withStatus(ContentStatus... status)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to that matching the given statuses.

Default status is "current" - only current content is found.

Specified by:

withStatus in interface ContentService.ParameterContentFinder

Parameters:

status - - the ContentStatus(es) to restrict to

Returns:

a finder with the ContentStatus restrictions applied

withStatus

public ContentService.ContentFinder withStatus(Iterable<ContentStatus> statuses)

Description copied from interface: ContentService.ParameterContentFinder

Restrict the fetched content to that matching the given statuses.

Default status is "current" - only current content is found.

Specified by:

withStatus in interface ContentService.ParameterContentFinder

Parameters:

statuses - an iterable of ContentStatus(es) to restrict to

Returns:

a finder with the ContentStatus restrictions applied

withAnyStatus

public ContentService.ContentFinder withAnyStatus()

Description copied from interface: ContentService.ParameterContentFinder

Don't restrict the fetched content on status.

Default status is "current" - if this method is not called, only current content is found.

Specified by:

withAnyStatus in interface ContentService.ParameterContentFinder

Returns:

a finder with no ContentStatus restrictions applied

fetchManyWithoutCaching

public PageResponse<Content> fetchManyWithoutCaching(ContentType type,
 PageRequest request)
                                              throws ServiceException

Specified by:

fetchManyWithoutCaching in interface ContentService.ContentFetcher

Throws:

ServiceException

fetchMany

public PageResponse<Content> fetchMany(ContentType type,
 PageRequest request)
                                throws ServiceException

Specified by:

fetchMany in interface ContentService.ContentFetcher

Throws:

ServiceException

fetchManyWithAnyType

public PageResponse<Content> fetchManyWithAnyType(PageRequest request)
                                           throws ServiceException

Specified by:

fetchManyWithAnyType in interface ContentService.ContentFetcher

Throws:

ServiceException

fetchMappedByContentType

public Map<ContentType,PageResponse<Content>> fetchMappedByContentType(PageRequest request)
                                                                throws ServiceException

Specified by:

fetchMappedByContentType in interface ContentService.ContentFetcher

Throws:

ServiceException