Package com.atlassian.confluence.search.v2

Class ContentSearch

java.lang.Object

com.atlassian.confluence.search.v2.AbstractSearch

com.atlassian.confluence.search.v2.ContentSearch

All Implemented Interfaces:

ISearch

public class ContentSearch
extends AbstractSearch

Represents a search against Confluence content. This includes searching against the text/body of content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContentSearch.Builder

Nested classes/interfaces inherited from class com.atlassian.confluence.search.v2.AbstractSearch

AbstractSearch.AbstractBuilder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_SEARCH
static final String	CQL_SEARCH
static final String	SITE_SEARCH

Fields inherited from class com.atlassian.confluence.search.v2.AbstractSearch

generatesToken, indices, limit, query, sort, startOffset

Constructor Summary

Constructors

Constructor	Description
ContentSearch(@NonNull SearchQuery query, SearchSort sort)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.
ContentSearch(@NonNull SearchQuery query, SearchSort sort, int startOffset, int limit)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.
ContentSearch(List<Index> indices, @NonNull SearchQuery query, SearchSort sort, int startOffset, int limit)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.

Method Summary

Modifier and Type	Method	Description
static ContentSearch.Builder	builder()
String	getSearchType()	Returns type of search e.g.
ContentSearch.Builder	toBuilder()

Methods inherited from class com.atlassian.confluence.search.v2.AbstractSearch

equals, generatesToken, getIndices, getLimit, getQuery, getSearchIndexes, getSort, getStartOffset, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.v2.ISearch

getHighlight, isExplain, withIndices, withLimit, withQuery

Field Details

SITE_SEARCH

public static final String SITE_SEARCH

See Also:

• Constant Field Values

CONTENT_SEARCH

public static final String CONTENT_SEARCH

See Also:

• Constant Field Values

CQL_SEARCH

public static final String CQL_SEARCH

See Also:

• Constant Field Values

Constructor Details

ContentSearch

@Deprecated(forRemoval=true)
public ContentSearch(@NonNull SearchQuery query,
 SearchSort sort)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.0. Use builder()

Constructs a search against Confluence content. The maximum number of results returned will be a system provided default.

Parameters:

query - the non-null query to perform against Confluence content

sort - how to order the results of the query

Since:

7.20

ContentSearch

@Deprecated(forRemoval=true)
public ContentSearch(@NonNull SearchQuery query,
 SearchSort sort,
 int startOffset,
 int limit)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.0. Use builder()

Constructs a search against Confluence content.

Parameters:

query - the non-null query to perform against Confluence content

sort - how to order the results of the query

startOffset - the zero-based offset of the first content result to return

limit - the maximum number content results to return

Since:

7.20

ContentSearch

@Deprecated(forRemoval=true)
public ContentSearch(List<Index> indices,
 @NonNull SearchQuery query,
 SearchSort sort,
 int startOffset,
 int limit)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.0. Use builder()

Since:

8.7.0

Method Details

getSearchType

public String getSearchType()

Description copied from interface: ISearch

Returns type of search e.g. SiteSearch, RecentUpdate, NetworkFeed, BlogUpdate, which can be used by search manager to switch between different implementations to support incremental roll out.

Returns:

type of search

toBuilder

public ContentSearch.Builder toBuilder()

Returns:

a builder that's initialised with the values of the current search object

builder

public static ContentSearch.Builder builder()