Package com.atlassian.confluence.search.v2

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

java.lang.Object

com.atlassian.confluence.search.v2.AbstractSearch.AbstractBuilder<SELF>

All Implemented Interfaces:

ISearch.Builder<ISearch>

Direct Known Subclasses:

ChangesSearch.Builder, ContentSearch.Builder, DefaultSearch.Builder

Enclosing class:

AbstractSearch

protected abstract static class AbstractSearch.AbstractBuilder<SELF extends AbstractSearch.AbstractBuilder<SELF>>
extends Object
implements ISearch.Builder<ISearch>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	generatesToken
protected List<Index>	indices
protected int	limit
protected SearchQuery	query
protected SearchSort	sort
protected int	startOffset

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
SELF	copyFrom(ISearch search)
SELF	generatesToken(boolean generatesToken)	Specifies whether the resulting SearchResults.getNextPageSearch() will be generated with a token.
SELF	indices(Index... indices)	Specifies the targeted indexes
SELF	indices(List<Index> indices)	Specifies the targeted indexes
SELF	limit(int limit)	Specifies the maximum page size (positive).
SELF	query(SearchQuery query)
SELF	sort(SearchSort sort)	Specifies the sort component of the search
SELF	startOffset(int startOffset)	Specifies the start offset (0 based).

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.search.v2.ISearch.Builder

build

Field Details

indices

protected List<Index> indices

query

protected SearchQuery query

sort

protected SearchSort sort

startOffset

protected int startOffset

limit

protected int limit

generatesToken

protected boolean generatesToken

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

copyFrom

public SELF copyFrom(ISearch search)

indices

public SELF indices(Index... indices)

Description copied from interface: ISearch.Builder

Specifies the targeted indexes

Specified by:

indices in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Parameters:

indices -

Returns:

the current builder

indices

public SELF indices(List<Index> indices)

Description copied from interface: ISearch.Builder

Specifies the targeted indexes

Specified by:

indices in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Parameters:

indices -

Returns:

the current builder

query

public SELF query(SearchQuery query)

Specified by:

query in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

sort

public SELF sort(SearchSort sort)

Description copied from interface: ISearch.Builder

Specifies the sort component of the search

Specified by:

sort in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Parameters:

sort -

Returns:

the current builder

startOffset

public SELF startOffset(int startOffset)

Description copied from interface: ISearch.Builder

Specifies the start offset (0 based).

Specified by:

startOffset in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Parameters:

startOffset -

Returns:

the current builder

limit

public SELF limit(int limit)

Description copied from interface: ISearch.Builder

Specifies the maximum page size (positive).

Specified by:

limit in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Parameters:

limit -

Returns:

the current builder

generatesToken

public SELF generatesToken(boolean generatesToken)

Description copied from interface: ISearch.Builder

Specifies whether the resulting SearchResults.getNextPageSearch() will be generated with a token. A search token allows additional searching to be performed against a specific version of the index.

Note: for backward compatibility reason, this value only applies to OpenSearch, since it's costly to always generate a token for every search request. On Lucene, this value is currently ignored, i.e. it will continue to generate a token for every search request. This may change in the future, so if you require a token, make sure to set this to true.

Specified by:

generatesToken in interface ISearch.Builder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Parameters:

generatesToken -

Returns:

the current builder

See Also:

• SearchWithToken.getSearchToken()