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

Class AbstractContentFinder

java.lang.Object

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

com.atlassian.confluence.api.impl.service.content.finder.AbstractContentFinder

All Implemented Interfaces:

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

Direct Known Subclasses:

ContentFinderImpl

public abstract class AbstractContentFinder
extends AbstractFinder<Content>
implements ContentService.ContentFinder

Field Summary

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

expansions

Constructor Summary

Constructors

Constructor	Description
AbstractContentFinder(Expansion... expansions)

Method Summary

Modifier and Type	Method	Description
Predicate<? super ContentEntityObject>	asPredicate()	gets the filters in this Finder as a predicates, entities that are accepted by this predicate match the finder criteria
protected Predicate<? super ContentEntityObject>	asPredicateWithContentType(ContentType type)	gets the filters in this Finder as a predicate with the addition of adding a contentType predicate for the given content type.
protected Predicate<? super ContentEntityObject>	asPredicateWithContentTypes(ContentType... types)
boolean	canExpand(String expansion)
ContentId	getContentContainerId()
ContentId	getContentId()
List<ContentId>	getContentIds()
List<ContentType>	getContentTypes()
LocalDate	getCreatedDate()
List<Space>	getSpaces()
List<ContentStatus>	getStatuses()
String	getTitle()
int	getVersion()
ContentService.ContentFinder	withAnyStatus()	Don't restrict the fetched content on status.
ContentService.ContentFinder	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.ContentFinder	withCreatedDate(LocalDate createdDate)	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.ContentFinder	withId(ContentId first, ContentId... tail)	Restrict the fetched content to those with the given ids, requires at least two ContentIds.
ContentService.ContentFinder	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.ContentFinder	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.ContentFinder	withTitle(String title)	Restrict the fetched content to those with the given title
ContentService.ContentFinder	withType(ContentType... type)	Restrict the fetched content to those matching the given contentType

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

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.content.ContentService.ContentFetcher

fetchMany, fetchManyWithAnyType, fetchManyWithoutCaching, fetchMappedByContentType

Methods inherited from interface com.atlassian.confluence.api.service.content.ContentService.ContentFinder

withLocator

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetch, fetchOneOrNull, fetchOrNull

Constructor Details

AbstractContentFinder

public AbstractContentFinder(Expansion... expansions)

Method Details

withSpace

public ContentService.ContentFinder 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

withContainer

public ContentService.ContentFinder 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.ContentFinder 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.ContentFinder 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

withType

public ContentService.ContentFinder 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.ContentFinder withCreatedDate(LocalDate createdDate)

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:

createdDate - - the publish date to restrict the content

Returns:

this ContentFinder with the creation date restriction applied

withTitle

public ContentService.ContentFinder 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

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

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

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

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

asPredicateWithContentType

protected Predicate<? super ContentEntityObject> asPredicateWithContentType(ContentType type)

gets the filters in this Finder as a predicate with the addition of adding a contentType predicate for the given content type.

Parameters:

type -

Returns:

asPredicateWithContentTypes

protected Predicate<? super ContentEntityObject> asPredicateWithContentTypes(ContentType... types)

asPredicate

public Predicate<? super ContentEntityObject> asPredicate()

gets the filters in this Finder as a predicates, entities that are accepted by this predicate match the finder criteria

Returns:

a predicate representation of this finder

getSpaces

public List<Space> getSpaces()

getContentTypes

public List<ContentType> getContentTypes()

getCreatedDate

public LocalDate getCreatedDate()

getTitle

public String getTitle()

getVersion

public int getVersion()

getContentId

public ContentId getContentId()

getContentContainerId

public ContentId getContentContainerId()

getStatuses

public List<ContentStatus> getStatuses()

getContentIds

public List<ContentId> getContentIds()