Package com.atlassian.confluence.rest.client

Class AbstractRemoteContentService.AbstractRemoteContentFinder

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<ContentService.ContentFinder>

com.atlassian.confluence.rest.client.AbstractRemoteContentService.AbstractRemoteContentFinder

All Implemented Interfaces:

RemoteContentService.RemoteContentFetcher, RemoteContentService.RemoteContentFinder, RemoteContentService.RemoteParameterContentFinder, RemoteContentService.RemoteSingleContentFetcher, RemoteSingleFetcher<Content>

Direct Known Subclasses:

GraphQLRemoteContentServiceImpl.RemoteContentFinderImpl, RemoteContentServiceImpl.RemoteContentFinderImpl

Enclosing class:

AbstractRemoteContentService

protected abstract class AbstractRemoteContentService.AbstractRemoteContentFinder
extends AbstractRemoteService<ContentService.ContentFinder>
implements RemoteContentService.RemoteContentFinder

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentId	contentId
protected List<ContentType>	contentTypes
protected LocalDate	createdDate
protected Expansion[]	expansions
protected String	spaceKey
protected com.google.common.collect.ImmutableList<ContentStatus>	statuses	Deprecated. since 8.7.0.
protected String	title
protected int	version

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

provider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRemoteContentFinder(AbstractRemoteContentService otherService, Expansion... expansions)

Method Summary

Modifier and Type	Method	Description
protected abstract CompletionStage<Optional<Content>>	fetchByIdCompletionStage()
CompletionStage<Optional<Content>>	fetchCompletionStage()
CompletionStage<Map<ContentType,PageResponse<Content>>>	fetchMappedByContentTypeCompletionStage(PageRequest request)
protected abstract com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Content>>	fetchOneById()	Deprecated. since 7.0.1.
protected List<ContentStatus>	getStatuses()
RemoteContentService.RemoteContentFinder	withAnyStatus()
RemoteContentService.RemoteParameterContentFinder	withCreatedDate(LocalDate time)
RemoteContentService.RemoteParameterContentFinder	withCreatedDate(org.joda.time.LocalDate time)
RemoteContentService.RemoteSingleContentFetcher	withId(ContentId contentId)
RemoteContentService.RemoteSingleContentFetcher	withId(ContentId first, ContentId... tail)	Note : currently unsupported Restrict the fetched content to those with the given ids, requires at least two ContentIds.
RemoteContentService.RemoteSingleContentFetcher	withId(Iterable<ContentId> contentIds)	Note : currently unsupported Restrict the fetched content to those with the given ids
RemoteContentService.RemoteSingleContentFetcher	withIdAndVersion(ContentId contentId, int version)
RemoteContentService.RemoteSingleContentFetcher	withLocator(ContentLocator locator)	Retrieve a piece of content by some more complex criteria (defined by the ContentLocator).
RemoteContentService.RemoteParameterContentFinder	withSpace(Space... spaces)
RemoteContentService.RemoteContentFinder	withStatus(ContentStatus... status)
RemoteContentService.RemoteParameterContentFinder	withTitle(String title)
RemoteContentService.RemoteParameterContentFinder	withType(ContentType... types)

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

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, deleteFuture, deleteFuture, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFutureOptional, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postFuture, postFuture, postFuture, postFutureToPageResponse, postVoidCompletionStage, putCompletionStage, putFuture

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.rest.client.RemoteContentService.RemoteContentFetcher

fetchMany, fetchManyCompletionStage, fetchMappedByContentType

Methods inherited from interface com.atlassian.confluence.rest.client.RemoteSingleFetcher

fetch, fetchOne, fetchOneOrNull, fetchOrNull, fetchOrNullCompletionStage

Field Detail

expansions

protected final Expansion[] expansions

contentId

protected ContentId contentId

version

protected int version

spaceKey

protected String spaceKey

contentTypes

protected List<ContentType> contentTypes

createdDate

protected LocalDate createdDate

title

protected String title

statuses

@Deprecated
protected com.google.common.collect.ImmutableList<ContentStatus> statuses

Deprecated.

since 8.7.0. Use getStatuses() instead.

Constructor Detail

AbstractRemoteContentFinder

protected AbstractRemoteContentFinder(AbstractRemoteContentService otherService,
                                      Expansion... expansions)

Method Detail

withId

public RemoteContentService.RemoteSingleContentFetcher withId(ContentId contentId)

Specified by:

withId in interface RemoteContentService.RemoteContentFinder

withIdAndVersion

public RemoteContentService.RemoteSingleContentFetcher withIdAndVersion(ContentId contentId,
                                                                        int version)

Specified by:

withIdAndVersion in interface RemoteContentService.RemoteContentFinder

withId

public RemoteContentService.RemoteSingleContentFetcher withId(ContentId first,
                                                              ContentId... tail)

Description copied from interface: RemoteContentService.RemoteContentFinder

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

Specified by:

withId in interface RemoteContentService.RemoteContentFinder

Returns:

this ContentFinder with the restrictions applied

withId

public RemoteContentService.RemoteSingleContentFetcher withId(Iterable<ContentId> contentIds)

Description copied from interface: RemoteContentService.RemoteContentFinder

Note : currently unsupported Restrict the fetched content to those with the given ids

Specified by:

withId in interface RemoteContentService.RemoteContentFinder

Parameters:

contentIds - - the list of contentIds to restrict to

Returns:

this ContentFinder with the restrictions applied

withLocator

public RemoteContentService.RemoteSingleContentFetcher withLocator(ContentLocator locator)

Description copied from interface: RemoteContentService.RemoteContentFinder

Retrieve a piece of content by some more complex criteria (defined by the ContentLocator).

Specified by:

withLocator in interface RemoteContentService.RemoteContentFinder

Parameters:

locator - the locator containing the criteria for the content you are looking for

Returns:

the content, if one exists matching the criteria, or none otherwise.

withSpace

public RemoteContentService.RemoteParameterContentFinder withSpace(Space... spaces)

Specified by:

withSpace in interface RemoteContentService.RemoteParameterContentFinder

withType

public RemoteContentService.RemoteParameterContentFinder withType(ContentType... types)

Specified by:

withType in interface RemoteContentService.RemoteParameterContentFinder

withCreatedDate

public RemoteContentService.RemoteParameterContentFinder withCreatedDate(LocalDate time)

Specified by:

withCreatedDate in interface RemoteContentService.RemoteParameterContentFinder

withCreatedDate

public RemoteContentService.RemoteParameterContentFinder withCreatedDate(org.joda.time.LocalDate time)

Specified by:

withCreatedDate in interface RemoteContentService.RemoteParameterContentFinder

withTitle

public RemoteContentService.RemoteParameterContentFinder withTitle(String title)

Specified by:

withTitle in interface RemoteContentService.RemoteParameterContentFinder

withStatus

public RemoteContentService.RemoteContentFinder withStatus(ContentStatus... status)

Specified by:

withStatus in interface RemoteContentService.RemoteContentFinder

withAnyStatus

public RemoteContentService.RemoteContentFinder withAnyStatus()

Specified by:

withAnyStatus in interface RemoteContentService.RemoteContentFinder

getStatuses

protected List<ContentStatus> getStatuses()

fetchMappedByContentTypeCompletionStage

public CompletionStage<Map<ContentType,PageResponse<Content>>> fetchMappedByContentTypeCompletionStage(PageRequest request)

Specified by:

fetchMappedByContentTypeCompletionStage in interface RemoteContentService.RemoteContentFetcher

fetchCompletionStage

public CompletionStage<Optional<Content>> fetchCompletionStage()

Specified by:

fetchCompletionStage in interface RemoteSingleFetcher<Content>

fetchOneById

@Deprecated
protected abstract com.atlassian.util.concurrent.Promise<com.atlassian.fugue.Option<Content>> fetchOneById()

Deprecated.

since 7.0.1. Use fetchByIdCompletionStage() instead.

fetchByIdCompletionStage

protected abstract CompletionStage<Optional<Content>> fetchByIdCompletionStage()

Since:

7.0.1