Package com.atlassian.confluence.search.v2

Class DecoratorSearchBuilder<SEARCH extends ISearch>

java.lang.Object

com.atlassian.confluence.search.v2.DecoratorSearchBuilder<SEARCH>

Type Parameters:

SEARCH - the ISearch decorator class that this builder builds

All Implemented Interfaces:

ISearch.Builder<SEARCH>

public class DecoratorSearchBuilder<SEARCH extends ISearch>
extends Object
implements ISearch.Builder<SEARCH>

A builder for a search object that decorates another search object.

Since:

9.0

Constructor Summary

Constructors

Constructor	Description
DecoratorSearchBuilder(ISearch.Builder<?> delegate, Function<ISearch,SEARCH> mapper)

Method Summary

Modifier and Type	Method	Description
SEARCH	build()
DecoratorSearchBuilder<SEARCH>	generatesToken(boolean generatesToken)	Specifies whether the resulting SearchResults.getNextPageSearch() will be generated with a token.
DecoratorSearchBuilder<SEARCH>	indices(List<Index> indices)	Specifies the targeted indexes
DecoratorSearchBuilder<SEARCH>	limit(int limit)	Specifies the maximum page size (positive).
DecoratorSearchBuilder<SEARCH>	query(SearchQuery query)
DecoratorSearchBuilder<SEARCH>	sort(SearchSort sort)	Specifies the sort component of the search
DecoratorSearchBuilder<SEARCH>	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

indices

Constructor Details

DecoratorSearchBuilder

public DecoratorSearchBuilder(ISearch.Builder<?> delegate,
 Function<ISearch,SEARCH> mapper)

Method Details

indices

public DecoratorSearchBuilder<SEARCH> indices(List<Index> indices)

Description copied from interface: ISearch.Builder

Specifies the targeted indexes

Specified by:

indices in interface ISearch.Builder<SEARCH extends ISearch>

Returns:

the current builder

query

public DecoratorSearchBuilder<SEARCH> query(SearchQuery query)

Specified by:

query in interface ISearch.Builder<SEARCH extends ISearch>

sort

public DecoratorSearchBuilder<SEARCH> sort(SearchSort sort)

Description copied from interface: ISearch.Builder

Specifies the sort component of the search

Specified by:

sort in interface ISearch.Builder<SEARCH extends ISearch>

Returns:

the current builder

startOffset

public DecoratorSearchBuilder<SEARCH> startOffset(int startOffset)

Description copied from interface: ISearch.Builder

Specifies the start offset (0 based).

Specified by:

startOffset in interface ISearch.Builder<SEARCH extends ISearch>

Returns:

the current builder

limit

public DecoratorSearchBuilder<SEARCH> limit(int limit)

Description copied from interface: ISearch.Builder

Specifies the maximum page size (positive).

Specified by:

limit in interface ISearch.Builder<SEARCH extends ISearch>

Returns:

the current builder

generatesToken

public DecoratorSearchBuilder<SEARCH> 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<SEARCH extends ISearch>

Returns:

the current builder

See Also:

• SearchWithToken.getSearchToken()

build

public SEARCH build()

Specified by:

build in interface ISearch.Builder<SEARCH extends ISearch>

Returns:

a new instance of ISearch.Builder